Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

VTQL Namespace Reference

Contains all high level stuff to handle connections to VTQLserver. More...


Compounds

class  VTQL::Connect
 Provides basic stuff for connections to a VTQLserver. More...

class  VTQL::CModul
 Base class for all moduls. More...

class  VTQL::AlevtPage
 Proviedes high level output of videotext pages, as alevt does it. More...

struct  VTQL::PgInfo
 Contains all the non-text information of a videotext page. More...

class  VTQL::Event_generic
 For handling connection in event mode, you will need a connection provieded by this class. More...

class  VTQL::CEModul
 Base class for all moduls, that handle events. More...

class  VTQL::EM_PageAlevt
 Get matching events and provide advanced output methods to display the page. More...

class  VTQL::Parse
 Parse a VTQL command line. More...

class  VTQL::Region_basic
 Parse matches within a VTQL command and test input lines for matches. More...

struct  VTQL::Region_basic::PageData
class  VTQL::ReadHexPage
class  VTQL::Query_generic
 For handling connection in query or configuration mode, you will need a connection provieded by this class. More...

class  VTQL::QMError_flag
 Handle errors at command execution. More...

class  VTQL::CQModul
 Base class for all moduls, that handle queries. More...

class  VTQL::QM_PageL
 Get a list of PgInfo from a search. More...

class  VTQL::QM_PageAlevt
 Get a list of AlevtPage from a search. More...

class  VTQL::QM_Stations
 Get a list of stations. More...

struct  VTQL::QM_Stations::StInfo
 station information. More...

struct  VTQL::Command
 Part of a command. More...


Enumerations

enum  { PARSE_INVALID_FREQ = -1, PARSE_UNKNOWN_FREQ = 0 }
enum  UserMode {
  UM_CONFIG = 0, UM_QUERY, UM_EVENT, UM_INSERT,
  UM_NOBODY
}
 The different connection modes. More...

enum  ShowMode { SM_LIST = 0, SM_HEX, SM_TEXT }
 The different page output modes. More...


Functions

std::string EscapeString (std::string in)
 Escape strings as requiered for VTQL. More...

std::string NextSep (char sep, std::string &line)
 Fetch next field while handling VTQL escaped strings. More...

char xtoupper (char c)
 Convert a character to uppercase. More...

const char * xstrcasestr (const char *haystack, const char *needle)
 Search for needle within a haystack as strstr() does, but case insensitive. More...


Variables

const std::string & sVersion
 Version number of library. It is "major.minor.rev".

const char * cppUserModes []
 The strings to a UserMode. More...

const char * cppShowModes []
 The strings to a ShowMode. More...

const unsigned VT_WIDTH
 Width of a Page in characters (40).

const unsigned VT_HEIGHT
 Height of a Page, i.e. the number of lines (25).

const struct CommandcmAllCmds []
 Array of all commands. More...


Detailed Description

Contains all high level stuff to handle connections to VTQLserver.

Todo:
Exception documentation.


Enumeration Type Documentation

enum VTQL::UserMode
 

The different connection modes.

Enumeration values:
UM_CONFIG  configuration mode.
UM_QUERY  query mode.
UM_EVENT  event mode.
UM_INSERT  insert mode.
UM_NOBODY  mode nobody.

enum VTQL::ShowMode
 

The different page output modes.

Enumeration values:
SM_LIST  list mode.
SM_HEX  hex mode.
SM_TEXT  text mode.


Function Documentation

std::string EscapeString std::string    in
 

Escape strings as requiered for VTQL.

Simply puts "'"s around the input string and escapes any "'" within it.

Parameters:
in  input string
Returns:
escaped string

std::string NextSep char    sep,
std::string &    line
 

Fetch next field while handling VTQL escaped strings.

Most of the VTQL output are tables, where the fields are sperated by some character. This function deletes the next field from line and returns it. It knows about escaped strings, so that a seperator within a escaped field is handeld correctly and the "'"s are removed.

Parameters:
sep  Field sperator (should not be '\'' :-).
line  input string (gets changed!)
Returns:
Next field (unescaped).

char xtoupper char    c [inline]
 

Convert a character to uppercase.

Also converts German Umlaute.

Parameters:
c  input character
Returns:
uppercase character

const char* xstrcasestr const char *    haystack,
const char *    needle
 

Search for needle within a haystack as strstr() does, but case insensitive.

The needle has to be in uppercase, to keep it fast. Anyway, it is quite slow, since it does not use assembler and maybe I do not use a fast algorithm. To compare case insensitive, we use xtoupper(char).

Parameters:
needle  In uppercase, done with xtoupper(char)
Returns:
Position in heystack of first match, NULL if no match.


Variable Documentation

const char* VTQL::cppUserModes[]
 

The strings to a UserMode.

E.g cppUserModes[UM_NOBODY]="NOBODY". The last field is NULL.

const char* VTQL::cppShowModes[]
 

The strings to a ShowMode.

E.g cppShow[SM_HEX]="HEX". The last field is NULL.

const struct Command* VTQL::cmAllCmds[]
 

Array of all commands.

This is an array of arrays of Command structure. Every array entry describes one command. The last array entry is a empty command. A command is a array of the Command structure, where the last field is {"",-1}. Anything is uppercase.

The array if filled with the contents of the file ../vtql.syntax


Generated on Sun Apr 14 17:37:04 2002 for libvtql by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002