#define INSETCOMMANDPARAMS_H
#include "InsetCode.h"
+
+#include "OutputParams.h"
+
#include "support/docstring.h"
-#include <iosfwd>
#include <string>
#include <vector>
#include <map>
namespace lyx {
class Lexer;
+class Buffer;
class ParamInfo {
public:
+ ///
+ ParamInfo() {}
+ /// Types of parameters
+ enum ParamType {
+ LATEX_OPTIONAL, /// normal optional argument
+ LATEX_REQUIRED, /// normal required argument
+ LYX_INTERNAL /// a parameter used internally by LyX
+ };
+ /// Special handling on output
+ enum ParamHandling {
+ HANDLING_NONE = 1, /// no special handling
+ HANDLING_ESCAPE = 2, /// escape special characters
+ HANDLING_LATEXIFY = 4, /// transform special characters to LaTeX macros
+ HANDLING_LTRIM = 8, /// trim blanks on the left
+ HANDLING_INDEX_ESCAPE = 16, /// escape makeindex special chars
+ };
///
class ParamData {
// No parameter may be named "preview", because that is a required
// flag for all commands.
public:
///
- ParamData(std::string const &, bool);
+ ParamData(std::string const &, ParamType, ParamHandling = HANDLING_NONE,
+ bool ignore = false,
+ docstring default_value = docstring());
///
std::string name() const { return name_; }
///
- bool isOptional() const { return optional_; }
+ ParamType type() const { return type_; }
+ ///
+ ParamHandling handling() const { return handling_; }
+ /// whether this is an optional LaTeX argument
+ bool isOptional() const;
+ ///
+ bool ignore() const { return ignore_; }
+ ///
+ docstring const & defaultValue() const { return default_value_; }
///
bool operator==(ParamData const &) const;
- ///
+ ///
bool operator!=(ParamData const & rhs) const
{ return !(*this == rhs); }
private:
///
std::string name_;
///
- bool optional_;
+ ParamType type_;
+ /// do we need special handling on latex output?
+ ParamHandling handling_;
+ ///
+ bool ignore_;
+ ///
+ docstring default_value_;
};
/// adds a new parameter
- void add(std::string const & name, bool optional);
+ /// If ignore is true, then the parameter is never saved, and is always
+ /// given the default value.
+ void add(std::string const & name, ParamType type,
+ ParamHandling = HANDLING_NONE, bool ignore = false,
+ docstring default_value = docstring());
///
bool empty() const { return info_.empty(); }
///
///
typedef std::vector<ParamData>::const_iterator const_iterator;
///
- const_iterator begin() const { return info_.begin(); }
- ///
- const_iterator end() const { return info_.end(); }
+ const_iterator const begin() const { return info_.begin(); }
///
+ const_iterator const end() const { return info_.end(); }
+ /// \return true if name corresponds to a parameter of some sort.
+ /// \return false if the parameter does not exist at all of it it
bool hasParam(std::string const & name) const;
///
+ ParamData const & operator[](std::string const & name) const;
+ ///
bool operator==(ParamInfo const &) const;
private:
///
explicit InsetCommandParams(InsetCode code,
std::string const & cmdName);
///
- std::string insetType() const { return insetName(insetCode_); }
+ std::string insetType() const;
///
InsetCode code() const { return insetCode_; }
- ///
- void read(Lexer &);
/// Parse the command
+ void read(Lexer &);
+ ///
+ void Read(Lexer &, Buffer const *);
///
void write(std::ostream &) const;
+ ///
+ void Write(std::ostream & os, Buffer const * buf) const;
/// Build the complete LaTeX command
- docstring const getCommand() const;
+ docstring getCommand(OutputParams const &) const;
/// Return the command name
std::string const & getCmdName() const { return cmdName_; }
/// Set the name to \p n. This must be a known name. All parameters
/// are cleared except those that exist also in the new command.
/// What matters here is the parameter name, not position.
void setCmdName(std::string const & n);
- /// FIXME Would be better removed, but is used in BufferView.cpp in
+ /// FIXME Would be better removed, but is used in BufferView.cpp in
/// ways that make removal hard.
- docstring const getFirstNonOptParam() const;
+ docstring getFirstNonOptParam() const;
/// get parameter \p name
+ /// LyX will assert if name is not a valid parameter.
docstring const & operator[](std::string const & name) const;
/// set parameter \p name
+ /// LyX will assert if name is not a valid parameter.
docstring & operator[](std::string const & name);
///
bool preview() const { return preview_; }
void preview(bool p) { preview_ = p; }
/// Clear the values of all parameters
void clear();
-
-private:
- ///
- /// Get information for inset type \p code.
- /// Returns 0 if the inset is not known.
- static ParamInfo const & findInfo(InsetCode code);
- /// Get information for \p code and command \p cmdName.
- /// Returns 0 if the combination is not known.
- /// Don't call this without first making sure the command name is
- /// acceptable to the inset.
- static ParamInfo const & findInfo(InsetCode code,
- std::string const & cmdName);
///
static bool isCompatibleCommand(InsetCode code, std::string const & s);
///
- std::string getDefaultCmd(InsetCode);
+ ParamInfo const & info() const { return info_; }
+ ///
+ docstring prepareCommand(OutputParams const & runparams,
+ docstring const & command, ParamInfo::ParamHandling handling) const;
+private:
+ std::string getDefaultCmd(InsetCode code);
+ /// checks whether we need to write an empty optional parameter
+ /// \return true if a non-empty optional parameter follows ci
+ bool writeEmptyOptional(ParamInfo::const_iterator ci) const;
+
/// Description of all command properties
ParamInfo info_;
/// what kind of inset we're the parameters for
/// The name of this command as it appears in .lyx and .tex files
std::string cmdName_;
///
+ // if we need to allow more than one value for a parameter, this
+ // could be made a multimap. it may be that the only thing that
+ // would then need changing is operator[].
typedef std::map<std::string, docstring> ParamMap;
/// The parameters, by name.
ParamMap params_;
projects / lyx.git / blobdiff