All Past Downloads

• procedure loadProject(XMLorTXTFileName : string, nodeToLoad : tree)
  

  Parameter	Type	Description
  XMLorTXTFileName	string	an input file whose content describes a node
  nodeToLoad	tree	the node to populate from the file; if omitted, it is defaulted to the global variable \samp{project}

  Loads a parse tree previously saved thanks to saveProject().

• function existDirectory(path : string) : bool
  

  Parameter	Type	Description
  path	string	path name of the directory

  The function checks the existence of a directory specified by the path argument.

• procedure extendExecutedScript(scriptContent : string)
  

  Parameter	Type	Description
  scriptContent	string	A piece of CodeWorker's script to compile at the end of the currently executed script

  Extend the currently executed CodeWorker's script with new instructions. The argument scriptContent is a piece of script to compile at the end of the executed script.

• function equalLastWrittenChars(text : string) : bool
  

  Parameter	Type	Description
  text	string	string value to compare

  Compare the text argument with last characters written in the output file.

This directive is located anywhere in the script to study, and requires a variable the code generation engine will populate with coverage data. The variable will be a list of sorted segments, entirely determined by their starting position in the output and by the position of the corresponding script instruction. These positions are respectively stored in attributes output and script.

An added information is assigned to the node representing the segment. It specifies the type of script instruction, belonging to one of the following values:

• R: rough text,
• W: expression, variable or call to a writeText()-family procedure,
• I: call to a insertText()-family procedure,
• O: call to overwritePortion() procedure,

Example:

rough text @this.name@ EOL
@
#coverage(project.coverage)

Let say that this.name is worth "VARIABLE_CONTENT". The script generates the following output file:

rough text VARIABLE_CONTENT EOL

The variable project.coverage is then worth the following list:

   ["0"] = "R"
     |--+
       script = 12
       output = 0
   ["1"] = "W"
     |--+
       script = 21
       output = 11
   ["2"] = "R"
     |--+
       script = 29
       output = 27

      Tree structure of the variable populated by the BNF engine
      for #matching(variable):
     
      * variable
        |
        +- rules[]: list of production rules (signatures only),
        |
        +- areas[]: table of positions in the input text, the
          | key is worth the position P; no item value
          +- begin[]: (optional) table for every rule starting
          | | at the position P, the key being worth the
          | | ending position Pf (decreasing order)
          | +- []: list of all rules matching [P, Pf] exactly,
          |
          +- end[]: (facultative) table for every rule ending at
            | the position P, the key being worth the
            | starting position Pi (increasing order)
            +- []: list of all rules matching [Pi, P] exactly,

Conditions conform to the syntax of usual CodeWorker expressions. When a break/watchpoint is activated, a block of instructions can be executed. The block is a piece of CodeWorker script.

• function duplicateIterator(oldIt : iterator, newIt : treeref) : bool
  

  Parameter	Type	Description
  oldIt	iterator	the original iterator to duplicate
  newIt	treeref	copy of the original iterator

  Duplicates an iterator or returns false if oldIt isn't an iterator.

• function createIterator(i : iterator, list : treeref) : bool
  

  Parameter	Type	Description
  i	iterator	iterator to initialize
  list	treeref	the iterator will point to the beginning of this list

  The variable i will become an iterator pointing to the first item of the list.

  If the list is empty, there is no iterator created and the function returns false.

  i must have been declared before.

• function createReverseIterator(i : iterator, list : treeref) : bool
  

  Parameter	Type	Description
  i	iterator	iterator to initialize
  list	treeref	the iterator will point to the end of this list

  The variable i will become an iterator pointing to the last item of the list and will iterate in the reverse order.

  If the list is empty, there is no iterator created and the function returns false.

  i must have been declared before.

• function index(i : iterator) : int
  

  Parameter	Type	Description
  i	iterator	iterator of a \samp{foreach} statement

  Returns the position of the item the iterator points to. The position in the list begins counting at 0.

• function prec(i : iterator) : bool
  

  Parameter	Type	Description
  i	iterator	iterator of a \samp{foreach} statement or pointing to items of a list

  The iterator will now point to the precedent item of the list and returns true if exists.

• function next(i : iterator) : bool
  

  Parameter	Type	Description
  i	iterator	iterator of a \samp{foreach} statement or pointing to items of a list

  The iterator will now point to the next item of the list and returns true if exists.

In front of a variable name never declared, the behaviour remains the same: the variable is inserted to the this context automatically as a new attribute.

The rationale is firstly for improving the reliability of scripts, detecting bad variable names like spelling or foolish mistake in the name, and secondly to prepare the introduction of Object-Oriented Programming into CodeWorker.

• function addToDate(date : string, format : string, shifting : string) : string
  

  Parameter	Type	Description
  date	string	the date to change
  format	string	the format to apply on the reading of the \samp{shifting} argument
  shifting	string	the offset values to apply on the date, whose meanings are known by the \samp{offset} argument

  Change a date by applying offset values on its internal representation. The internal representation holds the year / month / day and hour / minute / second and millisecond fields. You choose what fields to shift, giving a date format as the first argument, and an offset value for each fields seen in the format as the second argument.

  The field types have the same syntax as in the function formatDate, except that the field values might be negative.
  For instance, if the field type is "%m", the month must occupy 2 digits maximum for a positive offset, and 3 characters for a negative offset, the first one being the sign.

  The offsets are applied in the order they are read, from the left-hand side to the right.

  The function returns the value of the date after applying the shift.

• procedure allFloatingLocations(list : tree)
  

  Parameter	Type	Description
  list	tree	floating location names and their position

  Populates the argument list with all floating location registered to the current output stream, such as the entry key is the floating location name and the entry value is the position in the stream.

• function removeFloatingLocation(key : string) : int
  

  Parameter	Type	Description
  key	string	name of an existing floating position into the output stream

  Removes the floating location attached to key and returns its position. If the floating location belongs to a parent output stream, it is removed from the parent.

  The function returns a negative integer if the floating location doesn't exist.

• function sqrt(x : double) : double
  

  Parameter	Type	Description
  x	double	the number we want to calculate the square root

  Calculates the square root of x.

  An invalid number causes the function to throw an error.

• procedure sleep(millis : int)
  

  Parameter	Type	Description
  millis	int	how many milliseconds the execution must be suspended

  The procedure suspends the execution for millis milliseconds.

• procedure incrementIndentLevel()
  Increments the indentation level, used to indenting output files automatically while writing.

  If first call, it enables the indent-mode: each time a text will have to be written at the beginning of a line, the line will be indented, depending on the indentation level.

  Call the function decrementIndentLevel() to decrease the indentation.

• function decrementIndentLevel() : bool
  Decrements the indentation level, used to indenting output files automatically while writing.

  If the function returns false, the indentation level is worth zero and it disables the indent-mode. Otherwise, each time a text will have to be written at the beginning of a line, the line will be indented, depending on the indentation level.

  Call the function incrementIndentLevel() to increase the indentation.

{"a", {"yellow", "red"}, "submarine"}

• function isNumeric(number : string) : bool
  

  Parameter	Type	Description
  number	string	a floating-point number in text representation

  This predicate checks whether the string passed by parameter is a floating-point or not.

• if you parse a double at the beginning of "2. is a floating point", 2. is consumed.
• if you parse a double at the beginning of "2..n", 2 only is consumed.

• procedure insertElementAt(list : treeref, key : string, position : int)
  

  Parameter	Type	Description
  list	treeref	an array of nodes
  key	string	the entry key of the element to insert
  position	int	where to insert the new element, starting at 0

  Insert a new element to list, at a position given by the argument position. The argument key indicates the key of this element, which is built empty.

  If the key is an empty string, then the key is supposed to be worth the size of the list automatically.

  You can access the new element by writing either:
  

  list#[position]

  
  or
  

  list[key]

• aVariable#front ignored during the C++ translation in some cases,
• the keyword cascading wasn't taken into account while translating foreach and forfile,
• the return value of a BNF symbol (piece of text matched) wasn't concatenated correctly when needed (functionality rarely required).

Example:

// declaration of 3 local variables in one shot
local a = "1", b, c= 2;

Examples for a plugin named MyModule:

MyModulecw_d.dll
MyModulecw_d.so

Example:

scanFiles(dir, "project/examples", "src/*.cpp", true)

"project/examples/airplanes/src/*.cpp"
"project/examples/boats/yacht/src/*.cpp"
"project/examples/bicycles/src/*.cpp"

• the BNF directive #skipIgnore,
• the BNF binary operator ‘|>‘,

• initialization of predefined global variables (_ARGS and _REQUEST),
• C++ writing of variable expressions in general,
• implicit copy in a translation script,

<filename>(line-number): <error-message>

"<filename>" line line-number): <error-message>

• function countInputCols() : int
  Determines the column number in the line where the parse cursor points to.

• function countOutputCols() : int
  Determines the column number in the line where the output stream cursor points to.

Example:

#moveAhead [A]? [B]?

If A doesn‘t match, then B must match so that the scan has read at least one character.

• function getShortFilename(pathFilename : string) : string
  

  Parameter	Type	Description
  pathFilename	string	a file name with its path

  Returns the short name of a file, meaning without the path. It is composed of a radical + an extension.

codeworker <script-file> <arg1> ... <argN> [<switch>]*

It is more natural than the equivalent writing:

codeworker -script <script-file> -args <arg1> ... <argN> [<switch>]*

Example:

      local list;
      insert list["silverware"] = "tea spoon";
      insert list["Mountain"] = "Everest";
      insert list["SilverWare"] = "Tea Spoon";
      insert list["Boat"] = "Titanic";
      insert list["acrobat"] = "Circus";
     
      traceLine("Sorted list in a classical order:");
      foreach i in sorted by_value list {
          traceLine("\t" + i + " -> " + key(i));
      }


Output:
    Titanic -> Boat
    Everest -> Mountain
    Tea Spoon -> SilverWare
    Circus -> acrobat
    tea spoon -> silverware

An example is encapsulating a Trolltech-Qt widget for building GUI, implemented in a plugin or in an application linking with the CodeWorker‘s library, and handled from a CodeWorker‘s script.

• function computeMD5(text : string) : string
  

  Parameter	Type	Description
  text