Modelica.Utilities.Strings

Information

Library content

Package Strings contains functions to manipulate strings.

In the table below an example call to every function is given using the default options.

The functions "compare", "isEqual", "count", "find", "findLast", "replace", "sort" have the optional input argument caseSensitive with default true. If false, the operation is carried out without taking into account whether a character is upper or lower case.

Extends from Modelica.Icons.Library (Icon for library).

Package Content

Name	Description
length	Returns length of string
substring	Returns a substring defined by start and end index
repeat	Repeat a string n times
compare	Compare two strings lexicographically
isEqual	Determine whether two strings are identical
count	Count the number of non-overlapping occurrences of a string
find	Find first occurrence of a string within another string
findLast	Find last occurrence of a string within another string
replace	Replace non-overlapping occurrences of a string from left to right
sort	Sort vector of strings in alphabetic order
scanToken	Scan for the next token and return it
scanReal	Scan for the next Real number and trigger an assert if not present
scanInteger	Scan for the next Integer number and trigger an assert if not present
scanBoolean	Scan for the next Boolean number and trigger an assert if not present
scanString	Scan for the next Modelica string and trigger an assert if not present
scanIdentifier	Scan for the next Identifier and trigger an assert if not present
scanDelimiter	Scan for the next delimiter and trigger an assert if not present
scanNoToken	Scan string and check that it contains no more token
syntaxError	Print an error message, a string and the index at which scanning detected an error
Advanced	Advanced scanning functions

Modelica.Utilities.Strings.length

Information

Syntax

Strings.length(string);

Description

Returns the number of characters of "string".

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string

Outputs

Type	Name	Description
Integer	result	Number of characters of string

Modelica definition

function length "Returns length of string"
  extends Modelica.Icons.Function;
  input String string;
  output Integer result "Number of characters of string";
external "C" result = ModelicaStrings_length(string);
end length;

Modelica.Utilities.Strings.substring

Information

Syntax

string2 = Strings.substring(string, startIndex, endIndex);

Description

This function returns the substring from position startIndex up to and including position endIndex of "string" .

If index, startIndex, or endIndex are not correct, e.g., if endIndex > length(string), an assert is triggered.

Example

  string1 := "This is line 111";
  string2 := Strings.substring(string1,9,12); // string2 = "line"

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String from which a substring is inquired
Integer	startIndex		Character position of substring begin (index=1 is first character in string)
Integer	endIndex		Character position of substring end

Outputs

Type	Name	Description
String	result	String containing substring string[startIndex:endIndex]

Modelica definition

function substring 
  "Returns a substring defined by start and end index"

  extends Modelica.Icons.Function;
  input String string "String from which a substring is inquired";
  input Integer startIndex(min=1) 
    "Character position of substring begin (index=1 is first character in string)";
  input Integer endIndex(min=1) "Character position of substring end";
  output String result 
    "String containing substring string[startIndex:endIndex]";
external "C" result=ModelicaStrings_substring(string,startIndex,endIndex);
end substring;

Modelica.Utilities.Strings.repeat

Information

Syntax

string2 = Strings.repeat(n);
string2 = Strings.repeat(n, string=" ");

Description

The first form returns a string consisting of n blanks.

The second form returns a string consisting of n substrings defined by the optional argument "string".

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
Integer	n	1	Number of occurences
String	string	" "	String that is repeated

Outputs

Type	Name	Description
String	repeatedString	String containing n concatenated strings

Modelica definition

function repeat "Repeat a string n times"
  extends Modelica.Icons.Function;
  input Integer n(min=0) = 1 "Number of occurences";
  input String string=" " "String that is repeated";
  output String repeatedString "String containing n concatenated strings";
algorithm 
  repeatedString :="";
  for i in 1:n loop
     repeatedString := repeatedString + string;
  end for;
end repeat;

Modelica.Utilities.Strings.compare

Information

Syntax

result = Strings.compare(string1, string2);
result = Strings.compare(string1, string2, caseSensitive=true);

Description

Compares two strings. If the optional argument caseSensitive=false, upper case letters are treated as if they would be lower case letters. The result of the comparison is returned as:

  result = Modelica.Utilities.Types.Compare.Less     // string1 < string2
         = Modelica.Utilities.Types.Compare.Equal    // string1 = string2
         = Modelica.Utilities.Types.Compare.Greater  // string1 > string2

Comparison is with regards to lexicographical order, e.g., "a" < "b";

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string1
String	string2
Boolean	caseSensitive	true	= false, if case of letters is ignored

Outputs

Type	Name	Description
Compare	result	Result of comparison

Modelica definition

function compare "Compare two strings lexicographically"
  extends Modelica.Icons.Function;
  input String string1;
  input String string2;
  input Boolean caseSensitive=true "= false, if case of letters is ignored";
  output Modelica.Utilities.Types.Compare result "Result of comparison";
external "C" result = ModelicaStrings_compare(string1, string2, caseSensitive);
end compare;

Modelica.Utilities.Strings.isEqual

Information

Syntax

Strings.isEqual(string1, string2);
Strings.isEqual(string1, string2, caseSensitive=true);

Description

Compare whether two strings are identical, optionally ignoring case.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string1
String	string2
Boolean	caseSensitive	true	= false, if lower and upper case are ignored for the comparison

Outputs

Type	Name	Description
Boolean	identical	True, if string1 is identical to string2

Modelica definition

function isEqual "Determine whether two strings are identical"
  extends Modelica.Icons.Function;
  input String string1;
  input String string2;
  input Boolean caseSensitive=true 
    "= false, if lower and upper case are ignored for the comparison";
  output Boolean identical "True, if string1 is identical to string2";
algorithm 
  identical :=compare(string1, string2, caseSensitive) == Types.Compare.Equal;
end isEqual;

Modelica.Utilities.Strings.count

Information

Syntax

Strings.count(string, searchString)
Strings.count(string, searchString, startIndex=1,
                     caseSensitive=true)

Description

Returns the number of non-overlapping occurrences of string "searchString" in "string". The search is started at index "startIndex" (default = 1). If the optional argument "caseSensitive" is false, for the counting it does not matter whether a letter is upper or lower case. /p>

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String that is analyzed
String	searchString		String that is searched for in string
Integer	startIndex	1	Start search at index startIndex
Boolean	caseSensitive	true	= false, if lower and upper case are ignored for count

Outputs

Type	Name	Description
Integer	result	Number of occurrences of 'searchString' in 'string'

Modelica definition

function count 
  "Count the number of non-overlapping occurrences of a string"
  extends Modelica.Icons.Function;
  input String string "String that is analyzed";
  input String searchString "String that is searched for in string";
  input Integer startIndex(min=1)=1 "Start search at index startIndex";
  input Boolean caseSensitive=true 
    "= false, if lower and upper case are ignored for count";
  output Integer result "Number of occurrences of 'searchString' in 'string'";
protected 
  Integer lenSearchString = length(searchString);
  Integer i = startIndex;
algorithm 
  result := 0;
  while i <> 0 loop
     i := find(string, searchString, i, caseSensitive);
     if i > 0 then
        result := result + 1;
        i := i + lenSearchString;
     end if;
  end while;
end count;

Modelica.Utilities.Strings.find

Information

Syntax

index = Strings.find(string, searchString);
index = Strings.find(string, searchString, startIndex=1,
                     caseSensitive=true);

Description

Finds first occurence of "searchString" within "string" and return the corresponding index. Start search at index "startIndex" (default = 1). If the optional argument "caseSensitive" is false, lower and upper case are ignored for the search. If "searchString" is not found, a value of "0" is returned.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String that is analyzed
String	searchString		String that is searched for in string
Integer	startIndex	1	Start search at index startIndex
Boolean	caseSensitive	true	= false, if lower and upper case are ignored for the search

Outputs

Type	Name	Description
Integer	index	Index of the beginning of the first occurrence of 'searchString' within 'string', or zero if not present

Modelica definition

function find 
  "Find first occurrence of a string within another string"
  extends Modelica.Icons.Function;
  input String string "String that is analyzed";
  input String searchString "String that is searched for in string";
  input Integer startIndex(min=1)=1 "Start search at index startIndex";
  input Boolean caseSensitive=true 
    "= false, if lower and upper case are ignored for the search";
   output Integer index 
    "Index of the beginning of the first occurrence of 'searchString' within 'string', or zero if not present";
protected 
  Integer lengthSearchString = length(searchString);
  Integer len = lengthSearchString-1;
  Integer i = startIndex;
  Integer i_max = length(string) - lengthSearchString + 1;
algorithm 
  index := 0;
  while i <= i_max loop
     if isEqual(substring(string,i,i+len),
                searchString, caseSensitive) then
        index := i;
        i := i_max + 1;
     else
        i := i+1;
     end if;
  end while;
end find;

Modelica.Utilities.Strings.findLast

Information

Syntax

index = Strings.findLast(string, searchString);
index = Strings.findLast(string, searchString,
                         startIndex=length(string), caseSensitive=true,

Description

Finds first occurence of "searchString" within "string" when searching from the last character of "string" backwards, and return the corresponding index. Start search at index "startIndex" (default = length(string)). If the optional argument "caseSensitive" is false, lower and upper case are ignored for the search. If "searchString" is not found, a value of "0" is returned.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String that is analyzed
String	searchString		String that is searched for in string
Integer	startIndex	0	Start search at index startIndex. If startIndex = 0, start at length(string)
Boolean	caseSensitive	true	= false, if lower and upper case are ignored for the search

Outputs

Type	Name	Description
Integer	index	Index of the beginning of the last occurrence of 'searchString' within 'string', or zero if not present

Modelica definition

function findLast 
  "Find last occurrence of a string within another string"
  extends Modelica.Icons.Function;
  input String string "String that is analyzed";
  input String searchString "String that is searched for in string";
  input Integer startIndex(min=0)=0 
    "Start search at index startIndex. If startIndex = 0, start at length(string)";
  input Boolean caseSensitive=true 
    "= false, if lower and upper case are ignored for the search";
  output Integer index 
    "Index of the beginning of the last occurrence of 'searchString' within 'string', or zero if not present";
protected 
  Integer lenString = length(string);
  Integer lenSearchString = length(searchString);
  Integer i;
algorithm 
  i := if startIndex == 0 then lenString-lenSearchString+1 else startIndex;
  index := 0;
  while i >= 1 loop
     if isEqual(substring(string,i,i+lenSearchString-1),
                searchString, caseSensitive) then
        index := i;
        i := 0;
     else
        i := i-1;
     end if;
  end while;
end findLast;

Modelica.Utilities.Strings.replace

Information

Syntax

Strings.replace(string, searchString, replaceString);
Strings.replace(string, searchString, replaceString,
                startIndex=1, replaceAll=true, caseSensitive=true);

Description

Search in "string" for "searchString" and replace the found substring by "replaceString".

• The search starts at the first character of "string", or at character position "startIndex", if this optional argument is provided.
• If the optional argument "replaceAll" is true (default), all occurrences of "searchString" are replaced. If the argument is false, only the first occurrence is replaced.
• The search for "searchString" distinguishes upper and lower case letters. If the optional argument "caseSensitive" is false, the search ignores whether letters are upper or lower case.

The function returns the "string" with the performed replacements.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be modified
String	searchString		Replace non-overlapping occurrences of 'searchString' in 'string' with 'replaceString'
String	replaceString		String that replaces 'searchString' in 'string'
Integer	startIndex	1	Start search at index startIndex
Boolean	replaceAll	true	if false, replace only the first occurrence, otherwise all occurrences
Boolean	caseSensitive	true	= false, if lower and upper case are ignored when searching for searchString

Outputs

Type	Name	Description
String	result	Resultant string of replacement operation

Modelica definition

function replace 
  "Replace non-overlapping occurrences of a string from left to right"
  extends Modelica.Icons.Function;
  input String string "String to be modified";
  input String searchString 
    "Replace non-overlapping occurrences of 'searchString' in 'string' with 'replaceString'";
  input String replaceString "String that replaces 'searchString' in 'string'";
  input Integer startIndex=1 "Start search at index startIndex";
  input Boolean replaceAll=true 
    "if false, replace only the first occurrence, otherwise all occurrences";
  input Boolean caseSensitive=true 
    "= false, if lower and upper case are ignored when searching for searchString";
  output String result "Resultant string of replacement operation";
protected 
  Integer lenString = length(string);
  Integer lenSearchString = length(searchString);
  Integer i = startIndex;
  Integer i_found;
algorithm 
  result := if startIndex == 1 then "" else substring(string,1,startIndex-1);
  while i > 0 loop
     i_found := find(string, searchString, i, caseSensitive);
     if i_found > 0 then
        result := if i_found == 1 then 
                     replaceString else 
                     result + (if i_found-1<i then "" else substring(string, i, i_found-1)) + replaceString;
        i := i_found + lenSearchString;
        if i > lenString then
           i := 0;
        elseif not replaceAll then
           result := result + substring(string, i, lenString);
           i := 0;
        end if;
     elseif lenString<i then
        i := 0;
     else
        result := result + substring(string, i, lenString);
        i := 0;
     end if;
  end while;
end replace;

Modelica.Utilities.Strings.sort

Information

Syntax

stringVector2 = Streams.sort(stringVector1);
stringVector2 = Streams.sort(stringVector1, caseSensitive=true);

Description

Function sort(..) sorts a string vector stringVector1 in lexicographical order and returns the result in stringVector2. If the optional argument "caseSensitive" is false, lower and upper case letters are not distinguished.

Example

  s1 = {"force", "angle", "pressure"};
  s2 = Strings.sort(s1);
       -> s2 = {"angle", "force", "pressure"};

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	stringVector1[:]		vector of strings
Boolean	caseSensitive	true	= false, if lower and upper case are ignored when comparing elements of stringVector1

Outputs

Type	Name	Description
String	stringVector2[size(stringVector1, 1)]	string1 sorted in alphabetical order

Modelica definition

function sort "Sort vector of strings in alphabetic order"
  extends Modelica.Icons.Function;
  input String stringVector1[:] "vector of strings";
  input Boolean caseSensitive=true 
    "= false, if lower and upper case are ignored when comparing elements of stringVector1";
  output String stringVector2[size(stringVector1,1)] 
    "string1 sorted in alphabetical order";
  /* shellsort algorithm; should be improved later */
protected 
  Integer gap;
  Integer i;
  Integer j;
  String tempString;
  Integer nStringVector1 = size(stringVector1,1);
  Boolean swap;
algorithm 
  stringVector2 := stringVector1;
  gap := div(nStringVector1,2);

  while gap > 0 loop
     i := gap;
     while i < nStringVector1 loop
        j := i-gap;
        if j >= 0 then
           swap := compare(stringVector2[j+1], stringVector2[j+gap+1], caseSensitive)
                   == Modelica.Utilities.Types.Compare.Greater;
        else
           swap := false;
        end if;

        while swap loop
           tempString := stringVector2[j+1];
           stringVector2[j+1] := stringVector2[j+gap+1];
           stringVector2[j+gap+1] := tempString;
           j := j - gap;
           if j >= 0 then
              swap := compare(stringVector2[j+1], stringVector2[j+gap+1], caseSensitive)
                      == Modelica.Utilities.Types.Compare.Greater;
           else
              swap := false;
           end if;
        end while;
        i := i + 1;
     end while;
     gap := div(gap,2);
  end while;

end sort;

Modelica.Utilities.Strings.scanToken

Information

Syntax

(token, nextIndex) = Strings.scanToken(string, startIndex, unsigned=false);

Description

Function scanToken scans the string starting at index "startIndex" and returns the next token, as well as the index directly after the token. The returned token is a record that holds the type of the token and the value of the token:

Variable token.tokenType is an enumeration (emulated as a package with constants) that can have the following values:

   import T = Modelica.Utilities.Types.TokenType;

Modelica line comments ("// ... end-of-line/end-of-string") as well as white space is ignored. If "unsigned=true", a Real or Integer literal is not allowed to start with a "+" or "-" sign.

Example

  import Modelica.Utilities.Strings.*;
  import T = Modelica.Utilities.Types.TokenType;
  (token, index) := scanToken(string);
  if token.tokenType == T.RealToken then
     realValue := token.real;
  elseif token.tokenType == T.IntegerToken then
     integerValue := token.integer;
  elseif token.tokenType == T.BooleanToken then
     booleanValue := token.boolean;
  elseif token.tokenType == T.Identifier then
     name := token.string;
  else
     syntaxError(string,index,"Expected Real, Integer, Boolean or identifier token");
  end if;

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of string at character startIndex
Boolean	unsigned	false	= true, if Real and Integer tokens shall not start with a sign

Outputs

Type	Name	Description
TokenValue	token	Scanned token
Integer	nextIndex	Index of character after the found token; = 0, if NoToken

Modelica definition

function scanToken "Scan for the next token and return it"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1) = 1 
    "Start scanning of string at character startIndex";
  input Boolean unsigned=false 
    "= true, if Real and Integer tokens shall not start with a sign";
  output Types.TokenValue token "Scanned token";
  output Integer nextIndex 
    "Index of character after the found token; = 0, if NoToken";
protected 
  Integer startTokenIndex;
algorithm 
  // Initialize token
  token.real :=0.0;
  token.integer :=0;
  token.boolean :=false;
  token.string :="";

  // skip white space and line comments
  startTokenIndex := Advanced.skipLineComments(string, startIndex);
  if startTokenIndex > length(string) then
    token.tokenType := Modelica.Utilities.Types.TokenType.NoToken;
    nextIndex := startTokenIndex;
  else
    // scan Integer number
      (nextIndex, token.integer) := Advanced.scanInteger(string, startTokenIndex, unsigned);
       token.tokenType := Types.TokenType.IntegerToken;

    // scan Real number
    if nextIndex == startTokenIndex then
      (nextIndex, token.real) :=Advanced.scanReal(string, startTokenIndex, unsigned);
       token.tokenType := Types.TokenType.RealToken;
    end if;

    // scan String
    if nextIndex == startTokenIndex then
       (nextIndex,token.string) := Advanced.scanString(string, startTokenIndex);
        token.tokenType:= Types.TokenType.StringToken;
    end if;

    // scan Identifier or Boolean
    if nextIndex == startTokenIndex then
       (nextIndex,token.string) := Advanced.scanIdentifier(string, startTokenIndex);
       if nextIndex > startTokenIndex then
          if token.string == "false" then
             token.string := "";
             token.boolean :=false;
             token.tokenType := Types.TokenType.BooleanToken;
          elseif token.string == "true" then
             token.string := "";
             token.boolean := true;
             token.tokenType := Types.TokenType.BooleanToken;
          else
             token.tokenType := Types.TokenType.IdentifierToken;
          end if;
       end if;
    end if;

    // scan Delimiter
    if nextIndex == startTokenIndex then
       token.string :=substring(string, startTokenIndex, startTokenIndex);
       token.tokenType := Types.TokenType.DelimiterToken;
       nextIndex := startTokenIndex + 1;
    end if;
  end if;
end scanToken;

Modelica.Utilities.Strings.scanReal

Information

Syntax

             number = Strings.scanReal(string);
(number, nextIndex) = Strings.scanReal(string, startIndex=1,
                                            unsigned=false, message="");

Description

The first form, "scanReal(string)", scans "string" for a Real number with leading white space and returns the value.

The second form, "scanReal(string,startIndex,unsigned)", scans the string starting at index "startIndex", checks whether the next token is a Real literal and returns its value as a Real number, as well as the index directly after the Real number. If the optional argument "unsigned" is true, the real number shall not have a leading "+" or "-" sign.

If the required Real number with leading white space is not present in "string", an assert is triggered.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of string at character startIndex
Boolean	unsigned	false	= true, if Real token shall not start with a sign
String	message	""	Message used in error message if scan is not successful

Outputs

Type	Name	Description
Real	number	Value of real number
Integer	nextIndex	index of character after the found number

Modelica definition

function scanReal 
  "Scan for the next Real number and trigger an assert if not present"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1)=1 
    "Start scanning of string at character startIndex";
  input Boolean unsigned=false 
    "= true, if Real token shall not start with a sign";
  input String message="" 
    "Message used in error message if scan is not successful";
  output Real number "Value of real number";
  output Integer nextIndex "index of character after the found number";
algorithm 
  (nextIndex, number) :=Advanced.scanReal(string, startIndex, unsigned);
  if nextIndex == startIndex then
     nextIndex :=Advanced.skipWhiteSpace(string, startIndex);
     if unsigned then
        syntaxError(string, nextIndex, "Expected a Real number without a sign " + message);
     else
        syntaxError(string, nextIndex, "Expected a Real number " + message);
     end if;
  end if;
end scanReal;

Modelica.Utilities.Strings.scanInteger

Information

Syntax

             number = Strings.scanInteger(string);
(number, nextIndex) = Strings.scanInteger(string, startIndex=1,
                                               unsigned=false, message="");

Description

Function scanInteger scans the string starting at index "startIndex", checks whether the next token is an Integer literal and returns its value as an Integer number, as well as the index directly after the Integer number. An assert is triggered, if the scanned string does not contain an Integer literal with optional leading white space.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of string at character startIndex
Boolean	unsigned	false	= true, if Integer token shall not start with a sign
String	message	""	Message used in error message if scan is not successful

Outputs

Type	Name	Description
Integer	number	Value of Integer number
Integer	nextIndex	Index of character after the found number

Modelica definition

function scanInteger 
  "Scan for the next Integer number and trigger an assert if not present"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1)=1 
    "Start scanning of string at character startIndex";
  input Boolean unsigned=false 
    "= true, if Integer token shall not start with a sign";
  input String message="" 
    "Message used in error message if scan is not successful";
  output Integer number "Value of Integer number";
  output Integer nextIndex "Index of character after the found number";
algorithm 
  (nextIndex, number) :=Advanced.scanInteger(string, startIndex, unsigned);
  if nextIndex == startIndex then
     nextIndex :=Advanced.skipWhiteSpace(string, startIndex);
     if unsigned then
        syntaxError(string, nextIndex, "Expected an Integer number without a sign " + message);
     else
        syntaxError(string, nextIndex, "Expected an Integer number " + message);
     end if;
  end if;
end scanInteger;

Modelica.Utilities.Strings.scanBoolean

Information

Syntax

             number = Strings.scanBoolean(string);
(number, nextIndex) = Strings.scanBoolean(string, startIndex=1, message="");

Description

Function scanBoolean scans the string starting at index "startIndex", checks whether the next token is a Boolean literal (i.e., is either the string "false" or "true", if converted to lower case letters) and returns its value as a Boolean number, as well as the index directly after the Boolean number. An assert is triggered, if the scanned string does not contain a Boolean literal with optional leading white space.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of string at character startIndex
String	message	""	Message used in error message if scan is not successful

Outputs

Type	Name	Description
Boolean	number	Value of Boolean
Integer	nextIndex	Index of character after the found number

Modelica definition

function scanBoolean 
  "Scan for the next Boolean number and trigger an assert if not present"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1)=1 
    "Start scanning of string at character startIndex";
  input String message="" 
    "Message used in error message if scan is not successful";
  output Boolean number "Value of Boolean";
  output Integer nextIndex "Index of character after the found number";
protected 
  String identifier;
algorithm 
  (nextIndex, identifier) :=Advanced.scanIdentifier(string, startIndex);

  if nextIndex > startIndex then
     if identifier == "false" then
        number := false;
     elseif identifier == "true" then
        number := true;
     else
        nextIndex := startIndex;
     end if;
  end if;

  if nextIndex == startIndex then
     nextIndex :=Advanced.skipWhiteSpace(string, startIndex);
     syntaxError(string, nextIndex,
       "Expected a Boolean constant, i.e., \"false\" or \"true\" " + message);
  end if;
end scanBoolean;

Modelica.Utilities.Strings.scanString

Information

Syntax

             string2 = Strings.scanString(string);
(string2, nextIndex) = Strings.scanString(string, startIndex=1, message="");

Description

Function scanString scans the string starting at index "startIndex", checks whether the next token is a String literal and returns its value as a String, as well as the index directly after the String. An assert is triggered, if the scanned string does not contain a String literal with optional leading white space.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of string at character startIndex
String	message	""	Message used in error message if scan is not successful

Outputs

Type	Name	Description
String	result	Value of string
Integer	nextIndex	Index of character after the found string

Modelica definition

function scanString 
  "Scan for the next Modelica string and trigger an assert if not present"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1)=1 
    "Start scanning of string at character startIndex";
  input String message="" 
    "Message used in error message if scan is not successful";
  output String result "Value of string";
  output Integer nextIndex "Index of character after the found string";
algorithm 
  (nextIndex, result) :=Advanced.scanString(string, startIndex);
  if nextIndex == startIndex then
     nextIndex :=Advanced.skipWhiteSpace(string, startIndex);
     syntaxError(string, nextIndex, "Expected a string enclosed in double quotes " + message);
  end if;
end scanString;

Modelica.Utilities.Strings.scanIdentifier

Information

Syntax

             identifier = Strings.scanIdentifier(string);
(identifier, nextIndex) = Strings.scanIdentifier(string, startIndex=1, message="");

Description

Function scanIdentifier scans the string starting at index "startIndex", checks whether the next token is an Identifier and returns its value as a string, as well as the index directly after the Identifier. An assert is triggered, if the scanned string does not contain an Identifier with optional leading white space.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of identifier at character startIndex
String	message	""	Message used in error message if scan is not successful

Outputs

Type	Name	Description
String	identifier	Value of Identifier
Integer	nextIndex	Index of character after the found identifier

Modelica definition

function scanIdentifier 
  "Scan for the next Identifier and trigger an assert if not present"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1)=1 
    "Start scanning of identifier at character startIndex";
  input String message="" 
    "Message used in error message if scan is not successful";
  output String identifier "Value of Identifier";
  output Integer nextIndex "Index of character after the found identifier";
algorithm 
  (nextIndex, identifier) :=Advanced.scanIdentifier(string, startIndex);
  if nextIndex == startIndex then
     nextIndex :=Advanced.skipWhiteSpace(string, startIndex);
     syntaxError(string, nextIndex, "Expected an identifier " + message);
  end if;
end scanIdentifier;

Modelica.Utilities.Strings.scanDelimiter

Information

Syntax

             delimiter = Strings.scanDelimiter(string);
(delimiter, nextIndex) = Strings.scanDelimiter(string, startIndex=1,
                                 requiredDelimiters={","}, message="");

Description

Function scanDelimiter scans the string starting at index "startIndex", checks whether the next token is a delimiter string and returns its value as a string, as well as the index directly after the delimiter. An assert is triggered, if the scanned string does not contain a delimiter out of the list of requiredDelimiters. Input argument requiredDelimiters is a vector of strings. The elements may have any length, including length 0. If an element of the requiredDelimiters is zero, white space is treated as delimiter. The function returns delimiter="" and nextIndex is the index of the first non white space character.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of delimiters at character startIndex
String	requiredDelimiters[:]	{","}	Delimiters that are searched
String	message	""	Message used in error message if scan is not successful

Outputs

Type	Name	Description
String	delimiter	Found delimiter
Integer	nextIndex	Index of character after the found delimiter

Modelica definition

function scanDelimiter 
  "Scan for the next delimiter and trigger an assert if not present"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1)=1 
    "Start scanning of delimiters at character startIndex";
  input String requiredDelimiters[:]={","} "Delimiters that are searched";
  input String message="" 
    "Message used in error message if scan is not successful";
  output String delimiter "Found delimiter";
  output Integer nextIndex "Index of character after the found delimiter";
protected 
  Integer lenString = length(string);
  Integer lenDelimiter;
  Integer nDelimiters = size(requiredDelimiters,1);
  Integer endIndex;
  Boolean found;
  Integer i;

  encapsulated function concatenate "Concatenate strings together"
     input String strings[:];
     output String string;
  algorithm 
     string := "{\"";
     for i in 1:size(strings,1) loop
        if i == 1 then
           string := "{\"" + strings[1] + "\"";
        else
           string := string + ", \"" + strings[i] + "\"";
        end if;
     end for;
     string := string + "}";
  end concatenate;
algorithm 
  nextIndex := Advanced.skipLineComments(string,startIndex);
  found := false;
  i := 1;
  while not found and i <= nDelimiters loop
     lenDelimiter :=length(requiredDelimiters[i]);
     if lenDelimiter == 0 then
        found := true;
        delimiter := "";
     else
        endIndex :=nextIndex + lenDelimiter - 1;
        if endIndex <= lenString then
           if substring(string,nextIndex,endIndex) == requiredDelimiters[i] then
              found := true;
              delimiter := requiredDelimiters[i];
           end if;
        end if;
        i := i + 1;
     end if;
  end while;

  if found then
      nextIndex := nextIndex + lenDelimiter;
  else
     if size(requiredDelimiters,1) == 1 then
        syntaxError(string, nextIndex, "Expected delimiter \"" + requiredDelimiters[1] + "\"\n" + message);
     else
        syntaxError(string, nextIndex, "Expected a delimiter out of " +
                    concatenate(requiredDelimiters) + "\n" + message);
     end if;
  end if;
end scanDelimiter;

Modelica.Utilities.Strings.scanNoToken

Information

Syntax

Strings.scanNoToken(string, startIndex=1, message="");

Description

Function scanNoToken scans the string starting at index "startIndex" and checks whether there is no more token in the string. An assert is triggered if this is not the case, using the "message" argument as additional explanation in the error text.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String to be scanned
Integer	startIndex	1	Start scanning of string at character startIndex
String	message	""	Message used in error message if scan is not successful

Modelica definition

function scanNoToken 
  "Scan string and check that it contains no more token"
  extends Modelica.Icons.Function;
  input String string "String to be scanned";
  input Integer startIndex(min=1)=1 
    "Start scanning of string at character startIndex";
  input String message="" 
    "Message used in error message if scan is not successful";
protected 
  Integer nextIndex;
algorithm 
  nextIndex :=Advanced.skipLineComments(string, startIndex);
  if nextIndex <= length(string) then
     syntaxError(string, nextIndex, "Expected no more token " + message);
  end if;
end scanNoToken;

Modelica.Utilities.Strings.syntaxError

Information

Syntax

Strings.syntaxError(string, index, message);

Description

Function syntaxError prints an error message in the following form:

   Syntax error at column <index> of
   <string>
       ^       // shows character that is wrong
   <message>

where the strings withing <..> are the actual values of the input arguments of the function.

If the given string is too long, only a relevant part of the string is printed.

Extends from Modelica.Icons.Function (Icon for a function).

Inputs

Type	Name	Default	Description
String	string		String that has an error at position index
Integer	index		Index of string at which scanning detected an error
String	message	""	String printed at end of error message

Modelica definition

function syntaxError 
  "Print an error message, a string and the index at which scanning detected an error"
  extends Modelica.Icons.Function;
  input String string "String that has an error at position index";
  input Integer index "Index of string at which scanning detected an error";
  input String message="" "String printed at end of error message";

protected 
  Integer maxIndex = 40;
  Integer maxLenString = 60;
  Integer lenString = length(string);
  String errString;
  Integer index2 = if index < 1 then 1 else if index > lenString then lenString else index;
algorithm 
// if "string" is too long, skip part of the string when printing it
   if index2 <= maxIndex then
     errString := string;
   else
     errString := "... " + substring(string, index2-maxIndex, lenString);
     index2 := maxIndex + 5; // To mark right position
   end if;

   if length(errString) > maxLenString then
      errString := substring(errString, 1, maxLenString) + " ...";
   end if;

// Print error message
   Streams.error("Syntax error at character " + String(index) + " of\n" +
                 errString + "\n" +
                 repeat(index2-1, " ") + "*" + "\n" +
                 message);
end syntaxError;