bib.hpp

// bibhtml: Generates HTML page (with images) from BibTex files
// See: https://www.telecom-paris.fr/~elc/software/
//
// Copyright 2020 Eric Lecolinet (eric.lecolinet@gmail.com)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef __Bib__
#define __Bib__

#include <vector>
#include <map>
#include "bibdefs.hpp"
#include "bibentry.hpp"

class BibStyle;
class BibExtension;


enum class ShowImages{None, Left, Right};

enum class ShowLinks{None, Text, Icon};


class Bib {
public:
  typedef std::map<std::string, BibAuthors> AuthorMap;
  typedef std::map<std::string, BibGroup*> GroupMap;
  typedef std::map<std::string, BibEntry*> EntryMap;
  
  static Bib instance;
  static std::list<BibExtension*> extensions;

  ~Bib();
  void init(int argc, char *argv[]);
  
  bool interMode() const {return interMode_;}
  bool verboseMode() const {return verboseMode_;}
  bool breakLines() const {return breakLines_;}
  bool showNumbers() const {return showNumbers_;}
  ShowImages showImages() const {return showImages_;}
  ShowLinks showLinks() const {return showLinks_;}
  BibFields::ID showHeaders() const {return showHeaders_;}
  const std::string& imageDir() const {return imageDir_;}
  const std::string& htmlBegin() const {return htmlBegin_;}
  const std::string& htmlEnd() const {return htmlEnd_;}
  const BibEntries& medias() const {return medias_;}
  
  // - - Entries - -
  
  BibEntry* addEntry(const std::string& bibkey, const std::string& typeName, bool isAuxiliary);
  
  void completeEntry(BibEntry&);

  const BibEntry* getEntry(const std::string& bibkey) const;
  
  void select(const std::string& query_pattern);
  
  void sort(const std::string& sort_pattern);
  
  void clear();
  
  void readBib(const std::string& fileName, bool isAuxiliary);
  
  void setHtmlFile(const std::string& fileName);

  void setBibFile(const std::string& fileName);
  
  void writeHtml(bool display);
  
  void writeBib(bool display);
  
  // - - Authors - -
  
  BibAuthor* addAuthor(const std::string& lastname, const std::string& firstname);
  
  BibAuthor* getAuthor(const std::string& lastname, const std::string& firstname) const;
  
  const Bib::AuthorMap& authors() const {return authorMap_;}

  // - - Formatting - -

  void readTemplate(const std::string& fileName);

  void setFormat(const std::string& options);
  
  void setStyle(const std::string& styleKey);

  // - - Misc. - -

  void checkLinks(const std::string& fieldName);
  
  void showStats(std::string filename);

  void doCommand(const std::string& cmd, const std::string& args, bool& interFound, bool& showFound);
  
  static void echo(const std::string& msg);

  static void error(const char* command, const std::string& msg);
  
  static bool help();
  
private:
  friend class BibStats;
  bool
  templateSearched_{false}, hasMedias_{false},
  interMode_{false}, verboseMode_{false},
  breakLines_{true}, showNumbers_{false};
  ShowImages    showImages_{ShowImages::Left};
  ShowLinks     showLinks_{ShowLinks::Text};
  BibFields::ID showHeaders_{BibFields::ID::year};
  std::string   imageDir_;
  std::string   outHtml_{BibSettings::OutHtml};
  std::string   outBib_{BibSettings::OutBib};
  std::string   htmlBegin_, htmlEnd_;
  AuthorMap     authorMap_;
  GroupMap      groupMap_;
  EntryMap      entryMap_, styleMap_;
  BibEntries    *selectEntries_{nullptr}, allEntries_, medias_;
  BibStyle      *style_{nullptr};
  
  class Commands {
#define BIBCOMMANDS \
read, aux, images, templ, out, outhtml, outbib, format, all, select, sort,\
clear, show, showhtml, showbib, check, stats, help, i, inter, verbose, quit
  public:
    enum ID {BIBCOMMANDS};   // command IDs
    ccuty::stringset names;  // command names
    Commands() : names(STRINGIFY(BIBCOMMANDS)) {}
  };
  Commands commands_;
#undef BIBCOMMANDS
};

#endif