KWordMacroExpander Class Reference

#include <kmacroexpander.h>

Inheritance diagram for KWordMacroExpander:

Public Member Functions
	KWordMacroExpander (TQChar c='%')
Public Member Functions inherited from KMacroExpanderBase
	KMacroExpanderBase (TQChar c='%')
virtual	~KMacroExpanderBase ()
void	expandMacros (TQString &str)
bool	expandMacrosShellQuote (TQString &str, uint &pos)
bool	expandMacrosShellQuote (TQString &str)
void	setEscapeChar (TQChar c)
TQChar	escapeChar () const

Protected Member Functions
virtual int	expandPlainMacro (const TQString &str, uint pos, TQStringList &ret)
virtual int	expandEscapedMacro (const TQString &str, uint pos, TQStringList &ret)
virtual bool	expandMacro (const TQString &str, TQStringList &ret)=0

Detailed Description

Abstract base class for simple word macro substitutors.

Use this instead of the functions in the KMacroExpander namespace if speculatively pre-filling the substitution map would be too expensive.

A typical application:

class MyClass {
...
  private:
    TQString m_str;
...
  friend class MyExpander;
};
 
class MyExpander : public KWordMacroExpander {
  public:
    MyExpander( MyClass *_that ) : KWordMacroExpander(), that( _that ) {}
  protected:
    virtual bool expandMacro( const TQString &str, TQStringList &ret );
  private:
    MyClass *that;
};
 
bool MyExpander::expandMacro( const TQString &str, TQStringList &ret )
{
  if (str == "macro") {
    ret += complexOperation( that->m_str );
    return true;
  }
  return false;
}
 
... MyClass::...(...)
{
  TQString str;
  ...
  MyExpander mx( this );
  mx.expandMacrosShellQuote( str );
  ...
}

Alternatively MyClass could inherit from KWordMacroExpander directly.

Since

3.3

Author

Oswald Buddenhagen ossi@.nosp@m.kde..nosp@m.org

Definition at line 191 of file kmacroexpander.h.

Constructor & Destructor Documentation

KWordMacroExpander()

KWordMacroExpander::KWordMacroExpander ( TQChar  c = '%' )

inline

Constructor.

Parameters

c	escape char indicating start of macros, or TQChar::null for none

Definition at line 198 of file kmacroexpander.h.

Member Function Documentation

expandEscapedMacro()

int KWordMacroExpander::expandEscapedMacro ( const TQString &  str, uint  pos, TQStringList &  ret  )

protectedvirtual

This function is called every time the escape char is found if it is not TQChar::null.

It should determine whether the string starting at pos witin str is a valid macro and return the substitution value for it if so.

Parameters

str	the input string
pos	the offset within str. Note that this is the position of the occurrence of the escape char
ret	return value: the string to substitute for the macro

Returns

if greater than zero, the number of chars at pos in str to substitute with ret (i.e., a valid macro was found). if less than zero, subtract this value from pos (to skip a macro, i.e., substitute it with itself). zero requests no special action.

Reimplemented from KMacroExpanderBase.

Definition at line 469 of file kmacroexpander.cpp.

expandMacro()

virtual bool KWordMacroExpander::expandMacro ( const TQString &  str, TQStringList &  ret  )

protectedpure virtual

Return substitution list ret for string macro str.

Parameters

str	the macro to expand
ret	return variable reference. It is guaranteed to be empty when expandMacro is entered.

Returns

true iff chr was a recognized macro name

expandPlainMacro()

int KWordMacroExpander::expandPlainMacro ( const TQString &  str, uint  pos, TQStringList &  ret  )

protectedvirtual

This function is called for every single char within the string if the escape char is TQChar::null.

It should determine whether the string starting at pos within str is a valid macro and return the substitution value for it if so.

Parameters

str	the input string
pos	the offset within str
ret	return value: the string to substitute for the macro

Returns

if greater than zero, the number of chars at pos in str to substitute with ret (i.e., a valid macro was found). if less than zero, subtract this value from pos (to skip a macro, i.e., substitute it with itself). zero requests no special action.

Reimplemented from KMacroExpanderBase.

Definition at line 455 of file kmacroexpander.cpp.

---

The documentation for this class was generated from the following files:

• kmacroexpander.h
• kmacroexpander.cpp