string2.h

Go to the documentation of this file.

#pragma once

/*@+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H.Bril
 Date:          11-4-1994
 Contents:      Extra string functions
________________________________________________________________________
-*/

/* Functions making sure you don't need <string.h>

   (1) Usually OD::String or its subclass BufferString can already do the job
   (2) toString(XX) for all simple types
   (3) toXX from const char* for most used simple types
   (4) Replacements for strlen, strchr and strrstr
   (5) Various construction-, manipulation- and matching functions

 */

#include "basicmod.h"
#include "plftypes.h"
#include "commondefs.h"
#include <ctype.h>
#include <wctype.h>
namespace OD { class String; }
class CompoundKey;

mGlobal(Basic) const char* toString(od_int32);
mGlobal(Basic) const char* toString(od_uint32);
mGlobal(Basic) const char* toString(od_int64);
mGlobal(Basic) const char* toString(od_uint64);
mGlobal(Basic) const char* toString(float);
mGlobal(Basic) const char* toString(float,int nrdec);
mGlobal(Basic) const char* toString(float,char format,int precision);
mGlobal(Basic) const char* toStringLim(float,int maxtxtwdth);
mGlobal(Basic) const char* toStringPrecise(float);
mGlobal(Basic) const char* toString(double);
mGlobal(Basic) const char* toString(double,int nrdec);
mGlobal(Basic) const char* toString(double,char format,int precision);
mGlobal(Basic) const char* toStringLim(double,int maxtxtwdth);
mGlobal(Basic) const char* toStringPrecise(double);
mGlobal(Basic) const char* toString(short);
mGlobal(Basic) const char* toString(unsigned short);
mGlobal(Basic) const char* toString(const char*);
mGlobal(Basic) const char* toString(unsigned char);
mGlobal(Basic) const char* toString(signed char);
mGlobal(Basic) const char* toString(bool);
mGlobal(Basic) const char* toString(const OD::String&);
mGlobal(Basic) const char* toString(const CompoundKey&);

mGlobal(Basic) bool getFromString(int&,const char*,int udfval);
mGlobal(Basic) bool getFromString(od_int64&,const char*,od_int64 udfval);
mGlobal(Basic) bool getFromString(float&,const char*,float udfval);
mGlobal(Basic) bool getFromString(double&,const char*,double udfval);
mGlobal(Basic) bool getFromString(bool&,const char*);
mGlobal(Basic) bool yesNoFromString(const char*);

inline bool toBool( const char* s, bool defval=true )
{ return s && *s ? yesNoFromString(s) : defval; }

inline float toFloat( const char* s, float defval=0 )
{ float ret = defval; getFromString( ret, s, ret ); return ret; }

inline double toDouble( const char* s, double defval=0 )
{ double ret = defval; getFromString( ret, s, ret ); return ret; }

inline int toInt( const char* s, int defval=0 )
{ int ret = defval; getFromString( ret, s, ret ); return ret; }

inline od_int64 toInt64( const char* s, od_int64 defval=0 )
{ od_int64 ret = defval; getFromString( ret, s, ret ); return ret; }


#define mSkipBlanks(ptr) \
    { if ( ptr ) { while ( *(ptr) && iswspace(*(ptr)) ) (ptr)++; } }

#define mSkipNonBlanks(ptr) \
    { if ( ptr ) { while ( *(ptr) && !iswspace(*(ptr)) ) (ptr)++; } }

#define mTrimBlanks(ptr) \
    { mSkipBlanks(ptr); removeTrailingBlanks(ptr); }


mGlobal(Basic) bool caseInsensitiveEqual(const char*,const char*,
                                         int match_nrchars=-1);
mGlobal(Basic) bool stringStartsWith(const char* startstring,
                                const char* maybebigger);
mGlobal(Basic) bool stringStartsWithCI(const char*,const char*);
mGlobal(Basic) bool stringEndsWith(const char* endstring,
                                   const char* maybebigger);
mGlobal(Basic) bool stringEndsWithCI(const char*,const char*);
mGlobal(Basic) void removeTrailingBlanks(char*);
mGlobal(Basic) void cleanupString(char*,bool,bool,bool);
mGlobal(Basic) bool isNumberString(const char*,bool int_only=false);
mGlobal(Basic) bool isAlphaNumString(const char*,bool allowspace = false);
mGlobal(Basic) const char* getNextWord(const char*,char*);
mGlobal(Basic) int strLength(const char*);
mGlobal(Basic) const char* firstOcc(const char*,char);
mGlobal(Basic) const char* firstOcc(const char*,int);
mGlobal(Basic) char* firstOcc(char*,char);
mGlobal(Basic) char* firstOcc(char*,int);
mGlobal(Basic) const char* lastOcc(const char*,char);
mGlobal(Basic) const char* lastOcc(const char*,int);
mGlobal(Basic) char* lastOcc(char*,char);
mGlobal(Basic) char* lastOcc(char*,int);
mGlobal(Basic) const char* firstOcc(const char*,const char*);
mGlobal(Basic) char* firstOcc(char*,const char*);
mGlobal(Basic) const char* lastOcc(const char*,const char*);
mGlobal(Basic) char* lastOcc(char*,const char*);

mGlobal(Basic) const char* getYesNoString(bool);
mGlobal(Basic) const char* getDistUnitString(bool isfeet,bool withparentheses);
mGlobal(Basic) const char* getVelUnitString(bool isfeet,bool withparentheses);
mGlobal(Basic) const char* getRankPostFix(int);
mGlobal(Basic) const char* getBytesString(od_uint64);
mGlobal(Basic) const char* getLimitedDisplayString(const char*,int nrchars,
                                            bool trimright);
mGlobal(Basic) int getIndexInStringArrCI(const char*,const char* const* arr,
                                  int startnr=0,int nr_chars_to_match=0,
                                  int notfoundidx=-1);
mGlobal(Basic) const char* getAreaString(float m2,bool parensonunit,
                                         char* str=0);
mGlobal(Basic) char* truncateString(char* str, int maxlen );