Wizard Scripting Commands - Revision history

LETARTARE: delete 'UNDER CONSTRUCTION'

2017-07-08T13:53:40Z

delete 'UNDER CONSTRUCTION'

LETARTARE: delete 'UNDER CONSTRUCTION'

2017-07-08T13:52:58Z

delete 'UNDER CONSTRUCTION'

LETARTARE: delete 'UNDER CONSTRUCTION'

2017-07-08T13:51:59Z

delete 'UNDER CONSTRUCTION'

LETARTARE: some spelling mistakes

2014-01-01T18:09:12Z

some spelling mistakes

LETARTARE: /* Functions of the script 'common_functions.script' */

2013-02-12T14:10:00Z

Functions of the script 'common_functions.script'

LETARTARE: /* File path page */

2013-02-12T14:07:32Z

File path page

LETARTARE: /* Functions of the script 'common_functions.script' */

2013-02-12T14:01:03Z

Functions of the script 'common_functions.script'

LETARTARE: /* File path page */

2013-02-12T13:17:57Z

File path page

LETARTARE: /* Build target page */

2013-02-12T13:17:18Z

Build target page

LETARTARE: /* Release target */

2013-02-12T13:16:30Z

Release target

← Older revision		Revision as of 13:53, 8 July 2017
Line 380:		Line 380:

	= Common operations =		= Common operations =
−	~~'''UNDER CONSTRUCTION'''~~

	== Get various common info ==		== Get various common info ==

← Older revision		Revision as of 13:52, 8 July 2017
Line 6:		Line 6:
	= Global variables and basic primitive functions =		= Global variables and basic primitive functions =

−	~~'''UNDER CONSTRUCTION'''~~

	The first thing to know is that each wizard script contains		The first thing to know is that each wizard script contains

← Older revision		Revision as of 13:51, 8 July 2017
Line 523:		Line 523:

	= Functions of the script 'common_functions.script' =		= Functions of the script 'common_functions.script' =
−	~~'''UNDER CONSTRUCTION'''~~

	This script contains functions more complex but easier to implement		This script contains functions more complex but easier to implement

@@ Line 432: / Line 432: @@
 See [[Project_file#Compiler|Compiler : Internal name]]
-== Debug target ==
+=== Debug target ===
 {{Function_Description_0args|1=
-=== GetWantDebug() ===
+==== GetWantDebug() ====
 |2= (bool)
 }}
 {{Function_Description_0args|1=
-=== GeDebugName() ===
+==== GetDebugName() ====
 |2= target name (wxString)
 }}
 {{Function_Description_0args|1=
-=== GeDebugOutputDir() ===
+==== GetDebugOutputDir() ====
 |2= output directory (wxString)
 }}
 {{Function_Description_0args|1=
-=== GeDebugObjetOutputDir() ===
+==== GetDebugObjetOutputDir() ====
 |2= object output directory (wxString)
 }}
-== Release target ==
+=== Release target ===
 {{Function_Description_0args|1=
-=== GetWantRelease() ===
+==== GetWantRelease() ====
 |2= (bool)
 }}
 {{Function_Description_0args|1=
-=== GeReleaseName() ===
+==== GetReleaseName() ====
 |2= release name (wxString)
 }}
 {{Function_Description_0args|1=
-=== GeReleaseOutputDir() ===
+==== GetReleaseOutputDir() ====
 |2= output directory (wxString)
 }}
 {{Function_Description_0args|1=
-=== GeReleaseObjetOutputDir() ===
+==== GetReleaseObjetOutputDir() ====
 |2= object output directory (wxString)
 }}
@@ Line 477: / Line 477: @@
 {{Function_Description_0args|1=
-=== GeTargetEnableDebug () ===
+=== GetTargetEnableDebug () ===
 |2= (bool)
 }}
 {{Function_Description_0args|1=
-=== GeTargetName() ===
+=== GetTargetName() ===
 |2= target name (wxString)
 }}
 {{Function_Description_0args|1=
-=== GeTargetOutputDir() ===
+=== GetTargetOutputDir() ===
 |2= output directory (wxString)
 }}
 {{Function_Description_0args|1=
-=== GeTargetObjetOutputDir() ===
+=== GetTargetObjetOutputDir() ===
 |2= object output directory (wxString)
 }}

← Older revision		Revision as of 14:10, 12 February 2013
Line 725:		Line 725:
	}}		}}

		+	See also [[Wizard Scripting Commands#GetFileAddToProject()\|GetFileAddToProject()]]

	(to be continued)		(to be continued)

← Older revision	Revision as of 14:01, 12 February 2013
Line 583:	Line 583:


	+	{{Function_Description_1args\|1=
	+	=== VerifyDirectory(dir_or_macro) ===
	+	Verify a (provided) directory exists - otherwise throw an error.
	+	\|2=return the true directory having replaced all possible macros else _T("") (wxString)
	+	\|3=dir_or_macro
	+	\|4=wxString
	+	\|5=the directory or macros
	+	}}

	+
	+	{{Function_Description_1args\|1=
	+	=== VerifyMacro(macro) ===
	+	Try to make it a real path and verify it's existense
	+	\|2=return the true directory having replaced macros else _T("") (wxString)
	+	\|3=macro
	+	\|4=wxString
	+	\|5=the macro
	+	}}
	+
	+
	+	{{Function_Description_3args\|1=
	+	=== GetCompilerIncludeDir(selection, defaultSelection, defaultIncludeMacro) ===
	+	Get compiler include directory (taking GV's into account)
	+	\|2=the include directory (which maybe translated from a macro) else _T("") (wxString)
	+	\|3=selection
	+	\|4=wxString
	+	\|5=the original directory selection the user has made
	+	\|6=defaultSelection
	+	\|7=wxString
	+	\|8=the default directory proposed by the wizard (using a macro)
	+	\|9=defaultIncludeMacro
	+	\|10=wxString
	+	\|11=the default include directory proposed by the wizard (using a macro)
	+	}}
	+
	+
	+	{{Function_Description_3args\|1=
	+	=== GetCompilerIncludeMacro(selection, defaultSelection, defaultIncludeMacro) ===
	+	Get compiler include macro (if possible and a GV has been provided)
	+	\|2=the include macro (if possible), empty if not able to use a macro (wxString)
	+	\|3=selection
	+	\|4=wxString
	+	\|5=the original directory selection the user has made
	+	\|6=defaultSelection
	+	\|7=wxString
	+	\|8=the default directory proposed by the wizard (using a macro)
	+	\|9=defaultIncludeMacro
	+	\|10=wxString
	+	\|11=the default include directory proposed by the wizard (using a macro)
	+	}}
	+
	+
	+	{{Function_Description_3args\|1=
	+	=== GetCompilerLibDir(selection, defaultSelection, defaultLibMacro) ===
	+	Get compiler library directory (taking GV's into account)
	+	\|2=the include directory (which maybe translated from a macro) else _T("") (wxString)
	+	\|3=selection
	+	\|4=wxString
	+	\|5= the original directory selection the user has made
	+	\|6=defaultSelection
	+	\|7=wxString
	+	\|8=the default directory proposed by the wizard (using a macro)
	+	\|9=defaultIncludeMacro
	+	\|10=wxString
	+	\|11=the default library directory proposed by the wizard (using a macro)
	+	}}
	+
	+
	+	{{Function_Description_3args\|1=
	+	=== GetCompilerLibMacro(selection, defaultSelection, defaultLibMacro) ===
	+	Get compiler library macro (if possible and a GV has been provided)
	+	\|2=the library macro (if possible), empty if not able to use a macro (wxString)
	+	\|3=selection
	+	\|4=wxString
	+	\|5= the original directory selection the user has made
	+	\|6=defaultSelection
	+	\|7=wxString
	+	\|8=the default directory proposed by the wizard (using a macro)
	+	\|9=defaultIncludeMacro
	+	\|10=wxString
	+	\|11=the default library directory proposed by the wizard (using a macro)
	+	}}
	+
	+
	+	{{Function_Description_1args\|1=
	+	=== GetFixedProjectName(ProjectName) ===
	+	Converting project's name to be valid c++ identifier
	+	(needed for class names) and valid c++ file name
	+	(i.e. can not contain unicode and forbidden chars)
	+	\|2=return correct name else _T("") (wxString)
	+	\|3=ProjectName
	+	\|4=wxString
	+	\|5=project name
	+	}}
	+
	+
	+	{{Function_Description_3args\|1=
	+	=== VerifyFile(dir, file, type) ===
	+	Verify the existence of a file of specific type
	+	\|2=true, if the file exists, false otherwise (bool)
	+	\|3=dir
	+	\|4=wxString
	+	\|5=the directory the file is expected in
	+	\|6=file
	+	\|7=wxString
	+	\|8=name of the file to look for
	+	\|9=type
	+	\|10=wxString
	+	\|11=descriptive name of the file to show in the error message
	+	}}
	+
	+
	+	{{Function_Description_3args\|1=
	+	=== VerifyLibFile(dir, file, type) ===
	+	Verify the existence of a file of library type (add prefix lib, postfix .a and .lib)
	+	\|2= true, if the library exists, false otherwise (bool)
	+	\|3=dir
	+	\|4=wxString
	+	\|5=the directory the library is expected in
	+	\|6=file
	+	\|7=wxString
	+	\|8=name of the library to look for (usually for e.g. "libGL.a" providing "GL" is enough.
	+	\|9=type
	+	\|10=wxString
	+	\|11=descriptive name of the library to show in the error message
	+	}}
	+
	+
	+	{{Function_Description_2args\|1=
	+	=== AddFileToTargets(the_wiz, the_file) ===
	+	Add a file to a selection of target(s).Thus the wizard must have had a FilePathPanel for the selection of these.
	+	\|3=the_wiz
	+	\|4=wxString
	+	\|5=a reference to the wizard (to access the targets indexes)
	+	\|6=the_file
	+	\|7=wxString
	+	\|8=name of the file (including fuill path) that shall be added
	+	}}

@@ Line 494: / Line 494: @@
 == File path page ==
-{{Function_Description_1args|1=
+{{Function_Description_0args|1=
 === GetFilename() ===
 |2=file name (wxString)
 }}
-{{Function_Description_1args|1=
+{{Function_Description_0args|1=
 === GetFileHeaderGuard() ===
 |2=(bool)
 }}
-{{Function_Description_1args|1=
+{{Function_Description_0args|1=
 === GetFileAddToProject() ===
 |2= (bool)
 }}
-{{Function_Description_1args|1=
+{{Function_Description_0args|1=
 === GetFileTargetIndex() ===
 |2= (int)
@@ Line 516: / Line 516: @@
 |4= const wxString&
 }}
 Example : Wizard.SetFilePathSelectionFilter(_T("C++ files (*.cpp;*.cxx;*.cc)|*.cpp;*.cxx;*.cc"));
 = Functions of the script 'common_functions.script' =