MUString.h
Classes
- MUString -- Pointed String class to aid analysis of quantity strings (full description)
- Global Functions -- Output global functions (full description)
Interface
- Public Members
- friend ostream &operator<<(ostream &os, const MUString &in)
- MUString()
- MUString(const String &in)
- MUString(const Char *in)
- MUString(char in)
- MUString(const MUString &other)
- MUString &operator=(const MUString &other)
- ~MUString()
- String operator()()
- void push()
- void pop()
- void unpush()
- void skipBlank()
- Bool testBlank() const
- Bool tSkipBlank()
- void skipSign()
- Bool testSign() const
- Bool tSkipSign()
- Int getSign()
- void skipInt()
- Bool testInt() const
- Bool tSkipInt()
- Int getInt()
- void skipuInt()
- Bool tSkipuInt()
- Bool testuInt() const
- uInt getuInt()
- void skipDouble()
- Bool testDouble() const
- Bool tSkipDouble()
- Double getDouble()
- void skipChar(Int n=1)
- void skipChar(Char ch)
- Bool tSkipChar(Char nc)
- void skipCharNC(Char ch)
- Bool tSkipCharNC(Char ch)
- void skipChar(const Regex &ex)
- Bool tSkipChar(const Regex &ex)
- void skipAlpha()
- Bool tSkipAlpha()
- void skipNum()
- Bool tSkipNum()
- void skipAlphaNum()
- Bool tSkipAlphaNum()
- Bool testChar(Char ch) const
- Bool testCharNC(Char ch) const
- Bool testChar(const Regex &ex) const
- Bool testAlpha() const
- Bool testNum() const
- Bool testAlphaNum() const
- Char getChar()
- String getAlpha()
- String getAlphaNum()
- Bool testString(const Regex &ex) const
- Bool testString(const String &ex) const
- Bool testStringNC(const String &ex) const
- Bool tSkipString(const Regex &ex)
- Bool tSkipString(const String &ex)
- Bool tSkipStringNC(const String &ex)
- void skipString(const Regex &ex)
- void skipString(const String &ex)
- void skipStringNC(const String &ex)
- String getString(const Regex &ex)
- String getString(const String &ex)
- String getStringNC(const String &ex)
- Bool matchPair(Char nd)
- Int freqChar(Char ch) const
- String get()
- String get(uInt st)
- String get(uInt st, uInt nd)
- Int getPtr() const
- void setPtr(Int in=0)
- Bool eos() const
- Bool status() const
- const String &lastGet() const
- static uInt minimaxNC(const String &in, Int N_name, const String tname[])
- static uInt minimaxNC(const String &in, const Vector<String> &tname)
- Private Members
- void adjustPtr(Int in)
- Int initLast()
- void setLast(Int st)
Review Status
- Reviewed By:
- UNKNOWN
- Date Reviewed:
- before2004/08/25
- Programs:
- Tests:
Prerequisite
Etymology
From Measure Utility String
Synopsis
The MUString is a class with a String and an embedded pointer. It can be used
to linearly analyse a string for its semantics. Imagine for instance a
string that represents an angle. It could be formatted as
[+-]hh:mm:ss.ttt
or as [+-]hh[hH]mm[mM] or as
[+-]dd.mm.ss.ttt or with .'s replaced with
dms or as [+-]ddd.fff deg etc.
The available methods aid in analysing this string (see example).
The following analysis method classes are avaible:
- construct -- all constructors create a string with the pointer
starting at the beginning of the string
- testX(arg) -- all test methods test if the next available
character(s) fulfill the specified argument test. E.g.
Bool testSign() test if current character is + or -.
If at end of string; False is returned, except for
testBlank(). No pointer update. Any method with
NC at the end (for no-case) will test irrespective
of the case.
- skipX(arg) -- all skip methods skip all available character(s)
fulfilling the specified argument. E.g.
void skipSign() will skip all + and - found at
the current and subsequent positions. Pointer updated.
- tSkipX(arg) -- will skip as skipX, and return Bool as in testX.
Pointer updated
- getX(arg) -- will get the indicated X value from the string.
Pointer updated. A get will always return a valid result.
However, if the value did not exist (e.g.
Double getDouble()<src> form a string like <src>"abc"
will return 0.0) a False status will be saved. It can be
interrogated by the Bool status() function.
The string part used in producing the value is also
saved, and can be obtained with
const String &lastGet().
No saving in case of a simple getChar() is done.
- stack -- if it is necessary to save the current position of the
pointer (for maybe later restoration) a void push()
and void pop() are available
- pointer -- the pointer can be manipulated with void setPtr()
and Int getPtr(). Pointers are always protected in
their value.
The following types (X in the above list) are available
- Char -- a single character
- CharNC -- a single character with no case
- String -- a string
- StringNC -- a string without case
- Alpha -- a through z and A through Z and _ (underscore)
- Num -- digits 0 through 9
- AlphaNum -- a field staring with Alpha, and remainder (if any)
Alpha or Num
- Sign -- a plus or minus
- Blank -- a space ar a tab
- uInt -- unsigned integer
- Int -- an optionally signed integer
- Double -- a double value
General string aids are available. The main one a minimax, caseless
check of an input String against a vector:
static uInt minimaxNC(String in, Int N_name, String name[])
and its vector equivalent:
static uInt minimaxNC(String in, Vector<String> name).
Success is indicated by a return value less than N_name or the
vector length.
Example
See MVAngle class for example background.
The following example is the conversion of different input angle formats
to a Quantity. A full blown example,
but gives some idea of intricacies involved.
res = Quantity(0.0, "rad"); // result
MUString tmp(in); // Pointed non-const String
tmp.skipBlank();
Double s = tmp.getSign(); // sign
tmp.push(); // Save position to rescan
Double r = tmp.getuInt(); // first field
Int tp = 0; // distributor
if (tmp.tSkipChar('.')) { // if more than one ., dms format
Double r1 = tmp.getuInt();
if (tmp.tSkipChar('.')) {
r += r1/60.0 + tmp.getDouble()/3600.0;
tp = 4;
} else { // else value with units
tmp.pop(); // Reset position
r = tmp.getDouble();
};
} else if (tmp.tSkipCharNC('d')) { // dms
tp = 1;
} else if (tmp.tSkipCharNC('h')) { // hms
tp = 2;
} else if (tmp.tSkipChar(':')) { // hms
tp = 3;
};
switch (tp) {
case 0: {
UnitVal u; String us;
if (!MVAngle::unitString(u,us,tmp)) return False;
r *= s;
if (u == UnitVal::NODIM) { // check correct dimension
res = Quantity(r,"rad");
return True;
};
if (u == UnitVal::ANGLE) {
res = Quantity(r,us);
return True;
};
if (u == UnitVal::TIME) {
res = Quantity(Quantity(r/240.,us).getBaseValue(), "deg");
return True;
};
return False;
};
break;
case 1:
case 2:
case 3: { // get remainder od ms and hms formats
Char tc = 'm';
if (tp == 3) tc = ':';
tmp.push();
Double r1 = tmp.getuInt();
if (tmp.tSkipChar('.')) {
tmp.pop();
r += tmp.getDouble()/3600.;
} else if (tmp.tSkipCharNC(tc)) {
r += r1/60.0 + tmp.getDouble()/3600.;
} else {
r += r1/3600.0;
};
r *= s;
};
break;
default:
break;
};
switch (tp) { // make correct units
case 1:
case 4:
res = Quantity(r,"deg");
break;
case 2:
case 3:
res = Quantity(Quantity(r/240.,"h").getBaseValue(), "deg");
break;
default:
break;
};
return True;
Motivation
The class was written to be able to analyse an input string for its
Quantum representation as value with
units, or os a date/time or as an angle.
To Do
Member Description
friend ostream &operator<<(ostream &os, const MUString &in)
Output String starting at pointer
Default constructor creates an empty string
Create from String; setting pointer at start
MUString(const MUString &other)
Copy constructor; new pointer will be same as old
MUString &operator=(const MUString &other)
Copy assignment; new pointer will be same as old
Destructor
Obtain remaining string (same as get()).
Save current pointer on internal stack
void pop()
Restore pointer from stack (or set to start if stack empty)
Restore stack for one level
Act on whitespace; adjusting pointer if skip
Act on sign; return +1 or -1 depending on signs found (-- == +)
Act on integer field. If no integer found in 0 returned; and False
Act on Double field. If no value 0 returned and False.
Act on character(s)
Act on series of characters
Match a pair of opening(at pointer)/closing characters (e.g. ( and )).
Return False if wrong semantics. The string between the pair
(excluding them)
will be put in Last. If false, the ptr will be as originally; if True
it will point beyond the matched closing character
Int freqChar(Char ch) const
Get frequency of occurrence
Get part of string
Get pointer
void setPtr(Int in=0)
(Re-)set pointer
Bool eos() const
test for end of string
Bool status() const
Get status last get
Get String found at last get
Do minimax check on list of Strings
Member functions
Make a new pointer between 0 and len inclusive
Initialise last settings; return pointer
Set last settings
Interface
- ostream &operator<<(ostream &os, const MUString &in)
Global functions
Output
Member Description
ostream &operator<<(ostream &os, const MUString &in)