Difference between revisions of "IDE Macros in paths and filenames"

From Free Pascal wiki
Jump to navigationJump to search
m (List reorganization)
Line 1: Line 1:
 
{{IDE Macros in paths and filenames}}
 
{{IDE Macros in paths and filenames}}
  
 +
General Purpose
 
* Col - current column in source editor
 
* Col - current column in source editor
 
* Row - current row in source editor
 
* Row - current row in source editor
* CompPath - compiler path set in the environment options
 
 
* CurToken - current token at the cursor in the source editor
 
* CurToken - current token at the cursor in the source editor
 
* EdFile - current filename in the source editor
 
* EdFile - current filename in the source editor
 +
* MakeExe - path to the 'make' program (gmake under BSD)
 +
* Params - run parameters of the current project
 +
* Prompt - ask the user for a value. This is an interactive macro.
 +
* RunCmdLine - the command to launch the project
 +
* Save - save current file in source editor
 +
* SaveAll - save all
 +
* TargetCmdLine - the project executable plus run parameters
 +
 +
Filename Parts
 +
* Env(name) - macro function for environment variables given to the IDE (not project nor debugger) (since 0.9.27)
 +
* Ext() - macro function for ExtractFileExt
 +
* MakeDir() - macro function for AppendPathDelim
 +
* MakeFile() - macro function for ChompPathDelim
 +
* Name() - macro function for ExtractFileName
 +
* NameOnly() - macro function for ExtractFileNameOnly
 +
* Path() - macro function for ExtractFilePath
 +
 +
Pathes and Parts
 +
* CompPath - compiler path set in the environment options
 +
* ConfDir - directory where the IDE stores its config files
 
* ExeExt - executable file extension
 
* ExeExt - executable file extension
 
* FPCSrcDir - FPC source directory set in environment options
 
* FPCSrcDir - FPC source directory set in environment options
* LazarusDir - Lazarus source directory set in environment options
 
* LCLWidgetType - LCL widgetset of the current project
 
* TargetCPU - Target CPU of the current project
 
* TargetOS - Target OS of the current project
 
* SrcOS - 'unix' for linux, darwin, bsd. 'win' for win32, win64, wince
 
 
* FPCVer - FPC version (since 0.9.25). For example '2.2.2'.
 
* FPCVer - FPC version (since 0.9.25). For example '2.2.2'.
 
* LanguageID - IDE language, for example en for english, de for german
 
* LanguageID - IDE language, for example en for english, de for german
 
* LanguageName - IDE language name, the translated name of the current language. For instance: Deutsch for german.
 
* LanguageName - IDE language name, the translated name of the current language. For instance: Deutsch for german.
* Params - run parameters of the current project
+
* LazarusDir - Lazarus source directory set in environment options
* Prompt - ask the user for a value. This is an interactive macro.
+
* LCLWidgetType - LCL widgetset of the current project
 
* ProjFile - the full filename of the main source of the current project (.lpr)
 
* ProjFile - the full filename of the main source of the current project (.lpr)
 
* ProjPath - the project directory (the directory of the .lpi file)
 
* ProjPath - the project directory (the directory of the .lpi file)
* Save - save current file in source editor
 
* SaveAll - save all
 
 
* TargetFile - the output file of the current project (e.g. the executable or the library)
 
* TargetFile - the output file of the current project (e.g. the executable or the library)
* TargetCmdLine - the project executable plus run parameters
 
 
* TestDir - Test directory set in the environment options
 
* TestDir - Test directory set in the environment options
* RunCmdLine - the command to launch the project
+
* PkgDir() - macro function for the directory (location of the .lpk) of a package ID given as parameter
* ProjPublishDir - publishing directory of the current project
+
* PkgIncPath() - macro function for the include path of a package ID given as parameter
* ProjUnitPath - unit path of project directory
+
* PkgOutDir() - macro function for the output directory of a package (e.g. where the ppu files are created)
* ProjIncPath - include path of project directory
+
* PkgSrcPath() - macro function for the source path of a package ID given as parameter
* ProjSrcPath - source path of project directory
+
* PkgUnitPath() - macro function for the unit path of a package ID given as parameter
* ProjOutDir - path of project output directory (e.g. where the .ppu files are created) (since 0.9.27)
 
* ConfDir - directory where the IDE stores its config files
 
* MakeExe - path to the 'make' program (gmake under BSD)
 
 
* Project() - macro function for various values
 
* Project() - macro function for various values
 
** Project(UnitPath) - unit path of project directory
 
** Project(UnitPath) - unit path of project directory
Line 39: Line 48:
 
** Project(InfoFile) - filename of the project information file (.lpi) (since r15287, 0.9.25)
 
** Project(InfoFile) - filename of the project information file (.lpi) (since r15287, 0.9.25)
 
** Project(OutputDir) - directory where the project's ppu files are created (since 0.9.27)
 
** Project(OutputDir) - directory where the project's ppu files are created (since 0.9.27)
* Ext() - macro function for ExtractFileExt
+
* ProjIncPath - include path of project directory
* Path() - macro function for ExtractFilePath
+
* ProjOutDir - path of project output directory (e.g. where the .ppu files are created) (since 0.9.27)
* Name() - macro function for ExtractFileName
+
* ProjPublishDir - publishing directory of the current project
* NameOnly() - macro function for ExtractFileNameOnly
+
* ProjSrcPath - source path of project directory
* MakeDir() - macro function for AppendPathDelim
+
* ProjUnitPath - unit path of project directory
* MakeFile() - macro function for ChompPathDelim
+
* SrcOS - 'unix' for linux, darwin, bsd. 'win' for win32, win64, wince
* Env(name) - macro function for environment variables given to the IDE (not project nor debugger) (since 0.9.27)
+
* TargetCPU - Target CPU of the current project
 
+
* TargetOS - Target OS of the current project
* PkgDir() - macro function for the directory (location of the .lpk) of a package ID given as parameter
 
* PkgSrcPath() - macro function for the source path of a package ID given as parameter
 
* PkgUnitPath() - macro function for the unit path of a package ID given as parameter
 
* PkgIncPath() - macro function for the include path of a package ID given as parameter
 
* PkgOutDir() - macro function for the output directory of a package (e.g. where the ppu files are created)
 

Revision as of 13:42, 11 June 2009

Deutsch (de) English (en) español (es) français (fr) português (pt) русский (ru)

General Purpose

  • Col - current column in source editor
  • Row - current row in source editor
  • CurToken - current token at the cursor in the source editor
  • EdFile - current filename in the source editor
  • MakeExe - path to the 'make' program (gmake under BSD)
  • Params - run parameters of the current project
  • Prompt - ask the user for a value. This is an interactive macro.
  • RunCmdLine - the command to launch the project
  • Save - save current file in source editor
  • SaveAll - save all
  • TargetCmdLine - the project executable plus run parameters

Filename Parts

  • Env(name) - macro function for environment variables given to the IDE (not project nor debugger) (since 0.9.27)
  • Ext() - macro function for ExtractFileExt
  • MakeDir() - macro function for AppendPathDelim
  • MakeFile() - macro function for ChompPathDelim
  • Name() - macro function for ExtractFileName
  • NameOnly() - macro function for ExtractFileNameOnly
  • Path() - macro function for ExtractFilePath

Pathes and Parts

  • CompPath - compiler path set in the environment options
  • ConfDir - directory where the IDE stores its config files
  • ExeExt - executable file extension
  • FPCSrcDir - FPC source directory set in environment options
  • FPCVer - FPC version (since 0.9.25). For example '2.2.2'.
  • LanguageID - IDE language, for example en for english, de for german
  • LanguageName - IDE language name, the translated name of the current language. For instance: Deutsch for german.
  • LazarusDir - Lazarus source directory set in environment options
  • LCLWidgetType - LCL widgetset of the current project
  • ProjFile - the full filename of the main source of the current project (.lpr)
  • ProjPath - the project directory (the directory of the .lpi file)
  • TargetFile - the output file of the current project (e.g. the executable or the library)
  • TestDir - Test directory set in the environment options
  • PkgDir() - macro function for the directory (location of the .lpk) of a package ID given as parameter
  • PkgIncPath() - macro function for the include path of a package ID given as parameter
  • PkgOutDir() - macro function for the output directory of a package (e.g. where the ppu files are created)
  • PkgSrcPath() - macro function for the source path of a package ID given as parameter
  • PkgUnitPath() - macro function for the unit path of a package ID given as parameter
  • Project() - macro function for various values
    • Project(UnitPath) - unit path of project directory
    • Project(SrcPath) - source path of project directory
    • Project(IncPath) - include path of project directory
    • Project(InfoFile) - filename of the project information file (.lpi) (since r15287, 0.9.25)
    • Project(OutputDir) - directory where the project's ppu files are created (since 0.9.27)
  • ProjIncPath - include path of project directory
  • ProjOutDir - path of project output directory (e.g. where the .ppu files are created) (since 0.9.27)
  • ProjPublishDir - publishing directory of the current project
  • ProjSrcPath - source path of project directory
  • ProjUnitPath - unit path of project directory
  • SrcOS - 'unix' for linux, darwin, bsd. 'win' for win32, win64, wince
  • TargetCPU - Target CPU of the current project
  • TargetOS - Target OS of the current project