lyx_mirror/src/insets/InsetCommandParams.h

// -*- C++ -*-
/**
 * \file InsetCommandParams.h
 * This file is part of LyX, the document processor.
 * Licence details can be found in the file COPYING.
 *
 * \author Angus Leeming
 * \author Georg Baum
 *
 * Full author contact details are available in file CREDITS.
 */

#ifndef INSETCOMMANDPARAMS_H
#define INSETCOMMANDPARAMS_H

#include "support/docstring.h"

#include <iosfwd>
#include <vector>


namespace lyx {

class Lexer;

class InsetCommandParams {
public:
	/// Construct parameters for command \p name. \p name must be known.
	explicit InsetCommandParams(std::string const & name);
	///
	void read(Lexer &);
	/// Parse the command
	/// FIXME remove
	void scanCommand(std::string const &);
	///
	void write(std::ostream &) const;
	/// Build the complete LaTeX command
	docstring const getCommand() const;
	/// Return the command name
	std::string const & getCmdName() const { return name_; }
	/// this is used by listings package.
	std::string const getOptions() const;
private:
	/// FIXME remove
	std::string const getSecOptions() const;
public:
	/// FIXME remove
	std::string const getContents() const;
	/// 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);
	/// this is used by the listings package
	void setOptions(std::string const &);
private:
	/// FIXME remove
	void setSecOptions(std::string const &);
public:
	/// FIXME remove
	void setContents(std::string const &);
	/// get parameter \p name
	docstring const & operator[](std::string const & name) const;
	/// set parameter \p name
	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:
	///
	struct CommandInfo {
		/// Number of parameters
		size_t n;
		/// Parameter names. paramnames[n] must be "".
		char const * const * paramnames;
		/// Tells whether a parameter is optional
		bool const * optional;
	};
	/// Get information for command \p name.
	/// Returns 0 if the command is not known.
	static CommandInfo const * findInfo(std::string const & name);
	/// Description of all command properties
	CommandInfo const * info_;
	/// The name of this command as it appears in .lyx and .tex files
	std::string name_;
	///
	typedef std::vector<docstring> ParamVector;
	/// The parameters (both optional and required ones). The order is
	/// the same that is required for LaTeX output. The size of params_
	/// is always info_->n.
	ParamVector params_;
	///
	bool preview_;
	///
	friend bool operator==(InsetCommandParams const &,
			InsetCommandParams const &);
};


///
bool operator==(InsetCommandParams const &, InsetCommandParams const &);

///
bool operator!=(InsetCommandParams const &, InsetCommandParams const &);


} // namespace lyx

#endif