src/insets/InsetListingsParams.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetListingsParams.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Bo Peng
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETLISTINGSPARAMS_H
  13 #define INSETLISTINGSPARAMS_H
  14
  15 #include <map>
  16 #include <exception>
  17 #include "InsetCollapsable.h"
  18
  19 namespace lyx {
  20
  21 class InsetListingsParams {
  22 public:
  23         ///
  24         InsetListingsParams();
  25
  26         ///
  27         InsetListingsParams(std::string const &, bool in=false,
  28                 InsetCollapsable::CollapseStatus s = InsetCollapsable::Open);
  29
  30         /// write parameters to an ostream
  31         void write(std::ostream &) const;
  32
  33         /// read parameters from an ostream
  34         void read(Lexer &);
  35
  36         /// valid parameter string
  37         std::string params(std::string const & sep=",") const;
  38
  39         /// add key=value to params_. key_=value will be used if key=value already exists
  40         /// unless replace=true.
  41         void addParam(std::string const & key, std::string const & value,
  42                         bool replace = false);
  43
  44         /// add a few parameters
  45         void addParams(std::string const & par);
  46
  47         /// set params_ with par, throw an exception if par is valid
  48         void setParams(std::string const & par);
  49
  50         /// generate a parameter string that can be safely save and restored
  51         /// by lyx' lexer
  52         std::string encodedString() const;
  53
  54         /// newline (\n) separated parameters. comma can be removed.
  55         /// One possible complication is that , may appear in option value.
  56         std::string separatedParams(bool keepComma = false) const;
  57
  58         /// get parameter from encoded string
  59         void fromEncodedString(std::string const & par);
  60
  61         ///
  62         bool isInline() const { return inline_; }
  63
  64         ///
  65         bool isFloat() const;
  66
  67         ///
  68         InsetCollapsable::CollapseStatus status() const { return status_; }
  69
  70         ///
  71         void setInline(bool i) { inline_ = i; }
  72
  73         /// get value of option \c param
  74         std::string getParamValue(std::string const & param) const;
  75
  76         ///
  77         void clear() { params_.clear(); }
  78
  79         /// validate parameter, return an error message
  80         docstring validate() const;
  81
  82 private:
  83         /// inline or normal listings
  84         bool inline_;
  85
  86         /// key-value pairs of the parameters
  87         std::map<std::string, std::string> params_;
  88
  89         /// collapsable status
  90         InsetCollapsable::CollapseStatus status_;
  91 };
  92
  93
  94 } // namespace lyx
  95
  96 #endif