System macros

System macros are shorthand notations for lengthy path specifications that you may need to use for configuration, scripting or other tasks. Together knows how to expand the shorthand and make the proper reference.

You will most likely need to use macro references when doing customization tasks in the Tools tab of the Options dialog. Specific references to usage there are noted in blue font.

Macro

Description

$TGH$

contains the full path to your Together's installation. For example (c:\Together3).

$TOGETHER_HOME$

Identical to $TGH$

$SYSTEMJVM$

Contains the call of the installed Java VM, along with the value of the system's CLASSPATH environment variable. For example:
c:\jdk1.2\bin\java.exe -cp %CLASSPATH% (for Sun VM) c:\WINNT\jview.exe /cp %CLASSPATH% (for Microsoft VM)

You can use this macro in the "Java VM" option and add additional directories/archive files after a semicolon(Windows) or a colon(UNIX). For example:

$SYSTEMJVM$;c:\MyClassesDir (Windows)

$CLASSPATH$

contains the value of the system's CLASSPATH environment variable.

$CLASSPATH_JVM$

Contains the path to the classes.zip file.

$CLASSPATH_PROJECT$

contains the paths to all the packages in the project.

$SOURCEPATH$

contains the paths to all the writable packages in the project.

$DESTINATION$

contains the value of the Destination option in the Tools tab of the Options dialog (this value is defined in the "build.destination" property located in the tool.config file)

$MAINCLASS$

contains the name of a class in the project, defining the "public static void main (String[])" method. If there is no such class, this macro contains an empty line ("").

$LINENUMBER$

contains the line number of the selection in the file containing the selected element. For example, for selected operation this macro will contain the line in the file with the operation's class.

$CLASS_NAME$

contains the name of the selected class ( fully qualified name in Java).

$PROJECT_DIR$

contains the full path to the project's directory. For example, if the project is located in the c:\together3\myprojects\CoolProject directory, then this macro will contain the value "c:\together3\myprojects\CoolProject"

$PROJECT_NAME$

contains the name(without extension) of the project file. For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain "myproj".

$PROJECT_EXT$

contains the extension of the project file. For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain "tpr".

$PROJECT_FULLNAME$

contains the name (with extension) of the project file. For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain "myproj.tpr ".

$PROJECT_SPEC$

contains the full name of the project file (path, name and extension). For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain the value: "c:\together3\myprojects\CoolProject\myproj.tpr".

$FILELIST$

contains the "@somefile", where "somefile" is the name of the automatically generated file with the list of the files (each file on a new line) contained in the selection. (If the user clicked on the class, the "somefile" will contain only the file with the selected class, if the user clicked on a diagram, the "somefile" will contain all files representing the classes in the diagram and all the classes in the subpackages shown on this diagram, etc.)

$FILE _DIR$

contains the full path to the selected file's directory. For example, if the selected file is located in the c:\together3\myprojects\CoolProject directory, then this macro will contain "c:\together3\myprojects\CoolProject"

$FILE_NAME$

contains the name(without extension) of the selected file. For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "MyClass".

$FILE_EXT$

contains the extension of the selected file. For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "java".

$FILE_FULLNAME$

contains the name(with extension) of the selected file. For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "MyClass.java".

$FILE_SPEC$

contains the full name of the selected file (path, name and extension). For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "c:\together3\myprojects\CoolProject\MyClass.java".

$DEF_FILE_DIR$

contains the full path to the selected definition file's directory (C++ only). For example, if the selected definition file is located in the c:\together3\myprojects\CoolProject directory, then this macro will contain "c:\together3\myprojects\CoolProject". Definition files has .cpp extension

$DEF_FILE_NAME$

contains the name(without extension) of the selected definition file (C++ only). For example, if the selected definition file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain "guest".

$DEF_FILE_EXT$

contains the extension of the selected definition file (C++ only). For example, if the selected definition file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain "cpp".

$DEF_FILE_FULLNAME$

contains the name (with extension) of the selected definition file. For example, if the selected definition file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain "guest.cpp".

$DEF_FILE_SPEC$

contains the full name of the selected defintion file (path, name and extension) (C++ only). For example, if the selected file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain " c:\together3\myprojects\CoolProject\guest.cpp".

$PROMPT$

displays a dialog with a text input field and, when you press OK, returns the entered value. If you press CANCEL, an empty string is returned.

Variants:

$PROMPT:name=placeYourLabelHere$
Same as $PROMPT$, but you can specify the name (a string after the equal sign) of the label above the input field.

$PROMPT:name=placeYourLabelHere,default=placeDefaultValueHere$
Same as above, but allows you specify the default value of the input field. If you press CANCEL, the default value will be returned.

Note:
If there are several $PROMPT$ macros, then only one dialog will be displayed, containing fields specified in these macros, for example:

$PROMPT$$PROMPT:name=MyLabel$_someString_$PROMPT$

will display a dialog with three input fields, and when ther user presses OK, will return a string containing :

AB_someString_C, where A,B,C are the entered values.

Referencing configuration properties as macros

Besides using the predefined macros (described above), it is possible to use any of the properties defined in the *.config files. In this case you must write $:nameoftheproperty$. Note that you must use a colon after the first dollar sign ($). If you use a property named build.someproperty, you can write just $:someproperty$. For all other properties you must specify their full name.

Examples:

$:build.classpath$ - include the value of the property build.classpath (the value of this property is in the Tools tab ("Classpath") of the Options dialog)
$:classpath$ - you can use short names for properties build.*, same as above.
$:vcs.option.cvs.executable$ - include the value contained in the property vcs.option.cvs.executable

Macro	Description
$TGH$	contains the full path to your Together's installation. For example (c:\Together3).
$TOGETHER_HOME$	Identical to $TGH$
$SYSTEMJVM$	Contains the call of the installed Java VM, along with the value of the system's CLASSPATH environment variable. For example: c:\jdk1.2\bin\java.exe -cp %CLASSPATH% (for Sun VM) c:\WINNT\jview.exe /cp %CLASSPATH% (for Microsoft VM) You can use this macro in the "Java VM" option and add additional directories/archive files after a semicolon(Windows) or a colon(UNIX). For example: $SYSTEMJVM$;c:\MyClassesDir (Windows)
$CLASSPATH$	contains the value of the system's CLASSPATH environment variable.
$CLASSPATH_JVM$	Contains the path to the classes.zip file.
$CLASSPATH_PROJECT$	contains the paths to all the packages in the project.
$SOURCEPATH$	contains the paths to all the writable packages in the project.
$DESTINATION$	contains the value of the Destination option in the Tools tab of the Options dialog (this value is defined in the "build.destination" property located in the tool.config file)
$MAINCLASS$	contains the name of a class in the project, defining the "public static void main (String[])" method. If there is no such class, this macro contains an empty line ("").
$LINENUMBER$	contains the line number of the selection in the file containing the selected element. For example, for selected operation this macro will contain the line in the file with the operation's class.
$CLASS_NAME$	contains the name of the selected class ( fully qualified name in Java).
$PROJECT_DIR$	contains the full path to the project's directory. For example, if the project is located in the c:\together3\myprojects\CoolProject directory, then this macro will contain the value "c:\together3\myprojects\CoolProject"
$PROJECT_NAME$	contains the name(without extension) of the project file. For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain "myproj".
$PROJECT_EXT$	contains the extension of the project file. For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain "tpr".
$PROJECT_FULLNAME$	contains the name (with extension) of the project file. For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain "myproj.tpr ".
$PROJECT_SPEC$	contains the full name of the project file (path, name and extension). For example, if the project file is c:\together3\myprojects\CoolProject\myproj.tpr, then this macro will contain the value: "c:\together3\myprojects\CoolProject\myproj.tpr".
$FILELIST$	contains the "@somefile", where "somefile" is the name of the automatically generated file with the list of the files (each file on a new line) contained in the selection. (If the user clicked on the class, the "somefile" will contain only the file with the selected class, if the user clicked on a diagram, the "somefile" will contain all files representing the classes in the diagram and all the classes in the subpackages shown on this diagram, etc.)
$FILE _DIR$	contains the full path to the selected file's directory. For example, if the selected file is located in the c:\together3\myprojects\CoolProject directory, then this macro will contain "c:\together3\myprojects\CoolProject"
$FILE_NAME$	contains the name(without extension) of the selected file. For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "MyClass".
$FILE_EXT$	contains the extension of the selected file. For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "java".
$FILE_FULLNAME$	contains the name(with extension) of the selected file. For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "MyClass.java".
$FILE_SPEC$	contains the full name of the selected file (path, name and extension). For example, if the selected file is c:\together3\myprojects\CoolProject\MyClass.java, then this macro will contain "c:\together3\myprojects\CoolProject\MyClass.java".
$DEF_FILE_DIR$	contains the full path to the selected definition file's directory (C++ only). For example, if the selected definition file is located in the c:\together3\myprojects\CoolProject directory, then this macro will contain "c:\together3\myprojects\CoolProject". Definition files has .cpp extension
$DEF_FILE_NAME$	contains the name(without extension) of the selected definition file (C++ only). For example, if the selected definition file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain "guest".
$DEF_FILE_EXT$	contains the extension of the selected definition file (C++ only). For example, if the selected definition file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain "cpp".
$DEF_FILE_FULLNAME$	contains the name (with extension) of the selected definition file. For example, if the selected definition file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain "guest.cpp".
$DEF_FILE_SPEC$	contains the full name of the selected defintion file (path, name and extension) (C++ only). For example, if the selected file is c:\together3\myprojects\CoolProject\guest.cpp, then this macro will contain " c:\together3\myprojects\CoolProject\guest.cpp".
$PROMPT$	displays a dialog with a text input field and, when you press OK, returns the entered value. If you press CANCEL, an empty string is returned. Variants: $PROMPT:name=placeYourLabelHere$ Same as $PROMPT$, but you can specify the name (a string after the equal sign) of the label above the input field. $PROMPT:name=placeYourLabelHere,default=placeDefaultValueHere$ Same as above, but allows you specify the default value of the input field. If you press CANCEL, the default value will be returned. Note: If there are several $PROMPT$ macros, then only one dialog will be displayed, containing fields specified in these macros, for example: $PROMPT$$PROMPT:name=MyLabel$_someString_$PROMPT$ will display a dialog with three input fields, and when ther user presses OK, will return a string containing : AB_someString_C, where A,B,C are the entered values.