klamav/src/ctvariable.h

/***************************************************************************
 *   CT Environment Variable Header                                        *
 *   --------------------------------------------------------------------  *
 *   Copyright (C) 1999, Gary Meyer <gary@meyer.net>                       *
 *   --------------------------------------------------------------------  *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   * 
 ***************************************************************************/

#ifndef CTVARIABLE_H
#define CTVARIABLE_H

// Do not introduce any TQt or TDE dependencies into the "CT"-prefixed classes.
// I want to be able to reuse these classes with another GUI toolkit. -GM 11/99

#include <string>
#include <fstream>

/**
  * An environment variable (encapsulation of crontab environment variable
  * entry).  Encapsulates parsing and tokenization.
  */
class CTVariable
{
public:

/**
  * Constructs environment variable from crontab format string.
  */
  CTVariable(std::string tokStr = "", std::string _comment = "");

/**
  * Copy constructor.
  */
  CTVariable(const CTVariable& source);

/**
  * Assignment operator.
  */
  void operator = (const CTVariable& source);

/**
  * Default destructor.
  */
  // ~CTVariable();

/**
  * Tokenizes environment variable to crontab format.
  */
  friend std::ostream& operator << (std::ostream& outputStream, const CTVariable& task);

/**
  * Mark changes as applied.
  */
  void apply();

/**
  * Cancel changes.
  */
  void cancel();

/**
  * Indicates whether or not the environment variable has been modified.
  */
  bool dirty() const;

  std::string       variable;
  std::string       value;
  std::string       comment;
  bool         enabled;

private:
  std::string       initialVariable;
  std::string       initialValue;
  std::string       initialComment;
  bool         initialEnabled;

};

#endif // CTVARIABLE_H