update the ACM SIGPLAN files to latest layout and fileformat

[lyx.git] / src / BiblioInfo.h

diff --git a/src/BiblioInfo.h b/src/BiblioInfo.h
index 525cab50fdec27b0c290d1929d5622d18758d149..11a6361da807387fead5b94929295f8b0a38a972 100644 (file)
--- a/src/BiblioInfo.h
+++ b/src/BiblioInfo.h
@@ -11,11 +11,13 @@
  * Full author contact details are available in file CREDITS.
  */
 
-#ifndef BIBLIO_H
-#define BIBLIO_H
+#ifndef BIBLIOINFO_H
+#define BIBLIOINFO_H
 
 #include "support/docstring.h"
 
+#include "Citation.h"
+
 #include <vector>
 #include <map>
 #include <set>
@@ -25,49 +27,14 @@ namespace lyx {
        
 class Buffer;
 
-namespace biblio {
-
-enum CiteEngine {
-       ENGINE_BASIC,
-       ENGINE_NATBIB_AUTHORYEAR,
-       ENGINE_NATBIB_NUMERICAL,
-       ENGINE_JURABIB
-};
-
-enum CiteStyle {
-       CITE,
-       NOCITE,
-       CITET,
-       CITEP,
-       CITEALT,
-       CITEALP,
-       CITEAUTHOR,
-       CITEYEAR,
-       CITEYEARPAR
-};
-
-
-class CitationStyle {
-public:
-       ///
-       CitationStyle(CiteStyle s = CITE, bool f = false, bool force = false)
-               : style(s), full(f), forceUCase(force) {}
-       /// \param latex_str a LaTeX command, "cite", "Citep*", etc
-       CitationStyle(std::string const & latex_str);
-       ///
-       std::string const asLatexStr() const;
-       ///
-       CiteStyle style;
-       ///
-       bool full;
-       ///
-       bool forceUCase;
-};
-
+/// FIXME: To Citation.cpp?
 /// Returns a vector of available Citation styles.
-std::vector<CiteStyle> const getCiteStyles(CiteEngine const );
+std::vector<CiteStyle> citeStyles(CiteEngine);
+/// \param latex_str a LaTeX command, "cite", "Citep*", etc
+CitationStyle citationStyleFromString(std::string const & latex_str);
+/// the other way rounf
+std::string citationStyleToString(CitationStyle const &);
 
-} // namespace biblio
 
 /// Class to represent information about a BibTeX or
 /// bibliography entry.
@@ -77,9 +44,11 @@ class BibTeXInfo {
 public:
        ///
        typedef std::map<docstring, docstring>::const_iterator const_iterator;
+       ///
+       BibTeXInfo() : is_bibtex_(true) {}
        /// argument sets isBibTeX_, so should be false only if it's coming
        /// from a bibliography environment
-       BibTeXInfo(bool ib = true);
+       BibTeXInfo(bool ib) : is_bibtex_(ib) {}
        /// constructor that sets the entryType
        BibTeXInfo(docstring const & key, docstring const & type);
        /// Search for the given field and return the associated info.
@@ -106,20 +75,20 @@ public:
        docstring & operator[](docstring const & f) 
                { return bimap_[f]; }
        ///
-       docstring allData() const { return allData_; }
+       docstring const & allData() const { return all_data_; }
        ///
-       void allData(docstring const & d) { allData_ = d; }
+       void setAllData(docstring const & d) { all_data_ = d; }
        ///
-       docstring entryType() const { return entryType_; }
+       docstring entryType() const { return entry_type_; }
 private:
+       /// true if from BibTeX; false if from bibliography environment
+       bool is_bibtex_;
        /// the BibTeX key for this entry
-       docstring bibKey_;
+       docstring bib_key_;
        /// a single string containing all BibTeX data associated with this key
-       docstring allData_;
+       docstring all_data_;
        /// the BibTeX entry type (article, book, incollection, ...)
-       docstring entryType_;
-       /// true if from BibTeX; false if from bibliography environment
-       bool isBibTeX_;
+       docstring entry_type_;
        /// our map: <field, value>
        std::map <docstring, docstring> bimap_;
 };
@@ -129,17 +98,16 @@ private:
 /// from BibTeX or from bibliography environments.
 /// BiblioInfo.first is the bibliography key
 /// BiblioInfo.second is the data for that key
-class BiblioInfo : public std::map<docstring, BibTeXInfo> {
+class BiblioInfo {
 public:
+       ///
+       typedef std::map<docstring, BibTeXInfo>::const_iterator const_iterator;
        /// Returns a sorted vector of bibliography keys
        std::vector<docstring> const getKeys() const;
        /// Returns a sorted vector of present BibTeX fields
        std::vector<docstring> const getFields() const;
        /// Returns a sorted vector of BibTeX entry types in use
        std::vector<docstring> const getEntries() const;
-       /// Fills keys with BibTeX information derived from the various insets
-       /// in a given buffer, in its master document.
-       void fillWithBibKeys(Buffer const * const buf);
        /// return the short form of an authorlist
        docstring const getAbbreviatedAuthor(docstring const & key) const;
        /// return the year from the bibtex data record
@@ -149,7 +117,7 @@ public:
        docstring const getInfo(docstring const & key) const;
        
        /**
-         * "Translates the available Citation Styles into strings for a given key,
+         * "Translates" the available Citation Styles into strings for a given key,
          * either numerical or author-year depending upon the active engine. (See
          * below for those methods.)
          */
@@ -177,10 +145,33 @@ public:
                */
        std::vector<docstring> const
                        getAuthorYearStrings(docstring const & key, Buffer const & buf) const;
-
-       std::set<docstring> fieldNames;
-       std::set<docstring> entryTypes;
+       ///
+       const_iterator begin() const { return bimap_.begin(); }
+       ///
+       void clear() { bimap_.clear(); }
+       ///
+       bool empty() const { return bimap_.empty(); }
+       ///
+       const_iterator end() const { return bimap_.end(); }
+       ///
+       const_iterator find(docstring const & f) const { return bimap_.find(f); }
+       ///
+       void mergeBiblioInfo(BiblioInfo const & info);
+       ///
+       BibTeXInfo & operator[](docstring const & f) { return bimap_[f]; }
+       ///
+       void addFieldName(docstring const & f) { field_names_.insert(f); }
+       ///
+       void addEntryType(docstring const & f) { entry_types_.insert(f); }
+private:
+       ///
+       std::set<docstring> field_names_;
+       ///
+       std::set<docstring> entry_types_;
+       /// our map: keys --> BibTeXInfo
+       std::map<docstring, BibTeXInfo> bimap_;
 };
 
 } // namespace lyx
-#endif
+
+#endif // BIBLIOINFO_H