ofstd/include/ofconfig.h

/*
 *
 *  Copyright (C) 1997-2003, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module:  ofstd
 *
 *  Author: Marco Eichelberg
 *
 *  Purpose:
 *    classes: OFConfigFile
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2003/06/12 13:15:59 $
 *  CVS/RCS Revision: $Revision: 1.3 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef OFCONFIG_H
#define OFCONFIG_H

#include "osconfig.h"    /* make sure OS specific configuration is included first */
#include "ofstring.h"
#include "ofstack.h"

#define INCLUDE_CSTDIO
#include "ofstdinc.h"

/*
 *  Short description of configuration file structure:
 *    - The data in a configuration file have a tree structure.
 *      The tree has a fixed depth of (OFConfigFile_MaxLevel), not including
 *      the (imaginary) root node.
 *    - A level 0 entry (a leaf) has the form: KEYWORD = VALUE,
 *      where the keyword starts on row one of a line.
 *    - A level 1 entry has the form [KEYWORD]
 *    - A level 2 entry has the form [[KEYWORD]] (and so on).
 *    - Keywords may consist of:
 *        A..Z, a..z (which are converted to uppercase),
 *        0..9,
 *        '-'
 *    - Values can be any kind of ASCII text. Values may span multiple lines.
 *      To continue a value in the next line, the next line MUST start with
 *      (any amount of) whitespace, which is discarded when reading the value.
 *      linefeeds (converted to ASCII 10 if necessary) are kept in the
 *      value string. Empty lines are discarded (and also their linefeed).
 *    - The data must have a "clean" tree structure. This means that there
 *      MUST be a level 2 keyword before any level 1 keyword etc.
 *    - lines starting with "#" are interpreted as comment lines.
 *
 */

#define OFConfigFile_MaxLevel 2

class OFConfigFile;
class OFConfigFileNode;

typedef OFConfigFileNode *OFPConfigFileNode;


class OFConfigFileNode
{
public:
  OFConfigFileNode(const char *keyword);

  ~OFConfigFileNode();

  const char *getKeyword() const
  {
    return keyword_.c_str();
  }

  const char *getValue() const
  {
    return value_.c_str();
  }

  void setValue(const char *c)
  {
    value_ = c;
  }

  OFBool match(const char *c) const
  {
    return (keyword_ == c);
  }

  OFConfigFileNode *getBrother() const
  {
    return brother_;
  }

  OFConfigFileNode *getSon() const
  {
    return son_;
  }

  void setBrother(OFConfigFileNode *brother)
  {
    brother_ = brother;
  }

  void setSon(OFConfigFileNode *son)
  {
    son_ = son;
  }

private:
  OFConfigFileNode(const OFConfigFileNode& arg);

  OFConfigFileNode &operator=(const OFConfigFileNode& arg);

  OFConfigFileNode *brother_;

  OFConfigFileNode *son_;

  OFString keyword_;

  OFString value_;
};


class OFConfigFileCursor
{
public:
  OFConfigFileCursor() { clear(); }

  OFConfigFileCursor(const OFConfigFileCursor& source);

  ~OFConfigFileCursor() {}

  OFConfigFileCursor& operator=(const OFConfigFileCursor& source);

  void clear();

  const char *getKeyword(unsigned int level) const
  {
    return ptr[level]->getKeyword();
  }

  const char *getValue(unsigned int level) const
  {
    return ptr[level]->getValue();
  }

  OFBool section_valid(unsigned int level) const;

  void set_section(
    unsigned int level, 
    const char *key,
    OFConfigFileNode *anchor);
   
  void first_section(
    unsigned int level,
    OFConfigFileNode *anchor);

  void next_section(unsigned int level);

  void insert(
    unsigned int level,
    OFConfigFileNode *newnode,
    OFConfigFileNode *& anchor);

  OFBool operator<(const OFConfigFileCursor& /* arg */) const
  {
    return OFFalse;
  }

  OFBool operator==(const OFConfigFileCursor& /* arg */) const
  {
    return OFTrue;
  }

private:
  OFPConfigFileNode ptr[OFConfigFile_MaxLevel +1];
  
};


class OFConfigFile
{
public:

  OFConfigFile(FILE *infile);

  virtual ~OFConfigFile();

  const char *get_keyword(unsigned int level);
  
  const char *get_value();
  
  OFBool get_bool_value(OFBool defaultvalue);
  
  OFBool section_valid(unsigned int level) const
  {
    return cursor.section_valid(level);
  }
  
  void set_section(unsigned int level, const char *key)
  {
    cursor.set_section(level, key, anchor);
  }
   
  void first_section(unsigned int level)
  {
    cursor.first_section(level, anchor);
  }

  void next_section(unsigned int level)
  {
    cursor.next_section(level);
  }
  
  void save_cursor();
  
  void restore_cursor();
  
  void select_section(
    const char *key1,
    const char *key2=NULL);
  
  const char *get_entry(const char *key0);

private:  

  char read_char(FILE *infile);

  char read_keywordchar(FILE *infile);
  
  void read_entry(FILE *infile);
  
  void store_char(char c);

  OFConfigFile(const OFConfigFile&);
  
  OFConfigFile& operator=(const OFConfigFile&);


  OFStack<OFConfigFileCursor> stack;

  OFConfigFileCursor cursor;

  OFConfigFileNode *anchor;

  int isnewline;

  int crfound;

  char *buffer;

  size_t bufptr;

  long bufsize;
  
};

#endif

/*
 *  $Log: ofconfig.h,v $
 *  Revision 1.3  2003/06/12 13:15:59  joergr
 *  Fixed inconsistent API documentation reported by Doxygen.
 *
 *  Revision 1.2  2003/06/04 12:31:44  meichel
 *  Added dummy comparison operators, needed by MSVC5 with STL
 *
 *  Revision 1.1  2003/04/29 10:14:16  meichel
 *  Moved configuration file parser from module dcmpstat to ofstd and renamed
 *    class to OFConfigFile. Cleaned up implementation (no more friend declarations).
 *
 *
 */

---

Generated on 4 Nov 2004 for OFFIS DCMTK Version 3.5.3 by Doxygen 1.3.8