* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
- * \author Herbert Voß
+ * \author Herbert Voß
*
* Full author contact details are available in file CREDITS.
*/
-#ifndef INSET_CITE_H
-#define INSET_CITE_H
-
+#ifndef INSET_CITATION_H
+#define INSET_CITATION_H
#include "InsetCommand.h"
-#include "InsetCode.h"
-
-#include "BiblioInfo.h"
-
namespace lyx {
+class BufferParams;
+class CitationStyle;
-/** Used to insert citations
- */
-class InsetCitation : public InsetCommand {
+/////////////////////////////////////////////////////////////////////////
+//
+// InsetCitation
+//
+/////////////////////////////////////////////////////////////////////////
+
+/// Used to insert citations
+class InsetCitation : public InsetCommand
+{
public:
///
- InsetCitation(InsetCommandParams const &);
+ InsetCitation(Buffer * buf, InsetCommandParams const &);
+ ///
+ ~InsetCitation();
+
+ ///
+ bool addKey(std::string const & key);
+
+ /// \name Public functions inherited from Inset class
+ //@{
+ ///
+ bool isLabeled() const override { return true; }
+ ///
+ bool hasSettings() const override { return true; }
+ ///
+ docstring toolTip(BufferView const & bv, int x, int y) const override;
+ ///
+ void doDispatch(Cursor & cur, FuncRequest & cmd) override;
+ ///
+ bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const override;
+ ///
+ InsetCode lyxCode() const override { return CITE_CODE; }
+ ///
+ void latex(otexstream &, OutputParams const &) const override;
///
- docstring const getScreenLabel(Buffer const &) const;
+ int plaintext(odocstringstream & ods, OutputParams const & op,
+ size_t max_length = INT_MAX) const override;
///
- EDITABLE editable() const { return IS_EDITABLE; }
+ void docbook(XMLStream &, OutputParams const &) const override;
///
- InsetCode lyxCode() const { return CITE_CODE; }
+ docstring xhtml(XMLStream &, OutputParams const &) const override;
///
- int latex(Buffer const &, odocstream &,
- OutputParams const &) const;
+ void toString(odocstream &) const override;
///
- int plaintext(Buffer const &, odocstream &,
- OutputParams const &) const;
+ void forOutliner(docstring &, size_t const, bool const) const override;
///
- int docbook(Buffer const &, odocstream &,
- OutputParams const &) const;
- /// the string that is passed to the TOC
- void textString(Buffer const &, odocstream &) const;
+ void updateBuffer(ParIterator const & it, UpdateType, bool const deleted = false) override;
///
- void validate(LaTeXFeatures &) const;
+ void addToToc(DocIterator const & di, bool output_active,
+ UpdateType utype, TocBackend & backend) const override;
+ ///
+ std::string contextMenuName() const override;
+ ///
+ bool forceLTR(OutputParams const &) const override;
+ //@}
+
+ /// \name Static public methods obligated for InsetCommand derived classes
+ //@{
///
static ParamInfo const & findInfo(std::string const &);
- //FIXME This is the locus of the design problem we have.
- //It really ought to do what default_cite_command() does,
- //but to do that it needs to know what CiteEngine we are
- //using.
///
- static std::string defaultCommand() { return "cite"; };
+ static std::string defaultCommand() { return "cite"; }
+ ///
+ static bool isCompatibleCommand(std::string const &);
+ //@}
+ ///
+ typedef std::vector<std::pair<docstring, docstring>> QualifiedList;
+ ///
+ void redoLabel() { cache.recalculate = true; }
+ ///
+ CitationStyle getCitationStyle(BufferParams const & bp, std::string const & input,
+ std::vector<CitationStyle> const & valid_styles) const;
+ ///
+ QualifiedList getQualifiedLists(docstring const & p) const;
///
- static bool isCompatibleCommand(std::string const & cmd);
+ static bool last_literal;
+ /// Check whether citation contains necessary url/file entries
+ /// or external search script is available
+ bool openCitationPossible() const;
+ /// search and open citation source
+ void openCitation();
+ ///
+ std::pair<int, int> isWords() const override;
+
private:
+ /// tries to make a pretty label and makes a basic one if not
+ docstring generateLabel(bool for_xhtml = false) const;
+ /// makes a pretty label
+ docstring complexLabel(bool for_xhtml = false) const;
+ /// makes a very basic label, in case we can't make a pretty one
+ docstring basicLabel(bool for_xhtml = false) const;
+ /// trims the keys
+ void cleanKeys();
+
+ /// \name Private functions inherited from Inset class
+ //@{
///
- virtual Inset * clone() const
- { return new InsetCitation(params()); }
- /// we'll eventually want to be able to get info on this from the
- /// various CiteEngines
- static ParamInfo param_info_;
- /// This function does the donkey work of creating the pretty label
- docstring const generateLabel(Buffer const &) const;
+ Inset * clone() const override { return new InsetCitation(*this); }
+ //@}
+ /// \name Private functions inherited from InsetCommand class
+ //@{
///
- class Cache {
- public:
- ///
- Cache() : engine(biblio::ENGINE_BASIC), params(CITE_CODE) {}
- ///
- biblio::CiteEngine engine;
+ docstring screenLabel() const override;
+ //@}
+
+ ///
+ struct Cache {
+ Cache() : recalculate(true) {}
///
- InsetCommandParams params;
+ bool recalculate;
///
docstring generated_label;
///
} // namespace lyx
-#endif // INSET_CITE_H
+#endif // INSET_CITATION_H