lyx_mirror/src/Author.h
Juergen Spitzmueller a08cbf41cf Provide way to add (optional) user initials
This makes it easier to hook the changes package into LyX's ct markup.
2019-12-24 14:31:08 +01:00

106 lines
2.1 KiB
C++

// -*- C++ -*-
/**
* \file Author.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#ifndef AUTHOR_H
#define AUTHOR_H
#include "support/docstring.h"
#include <vector>
namespace lyx {
class Author {
public:
///
Author() : used_(false), buffer_id_(0) {};
///
Author(docstring const & name, docstring const & email,
docstring const & initials);
/// For when the \author line is missing (#9854)
Author(int buffer_id);
///
docstring name() const { return name_; }
///
docstring email() const { return email_; }
///
docstring initials() const { return initials_; }
///
docstring nameAndEmail() const;
///
int bufferId() const { return buffer_id_; }
///
void setBufferId(int buffer_id) const { buffer_id_ = buffer_id; }
///
void setUsed(bool u) const { used_ = u; }
///
bool used() const { return used_; }
/// Was the author line not missing?
bool valid() const;
///
friend std::istream & operator>>(std::istream & os, Author & a);
///
friend std::ostream & operator<<(std::ostream & os, Author const & a);
private:
/// The author's name
docstring name_;
/// The author's email address
docstring email_;
/// The author's initials
docstring initials_;
///
mutable bool used_;
/// The id of the author in the lyx-file
mutable int buffer_id_;
};
class AuthorList {
public:
///
AuthorList();
///
int record(Author const & a);
///
void record(int id, Author const & a);
///
void recordCurrentAuthor(Author const & a);
///
Author const & get(int id) const;
///
void sort();
///
typedef std::vector<Author> Authors;
///
Authors::const_iterator begin() const;
///
Authors::const_iterator end() const;
///
friend
std::ostream & operator<<(std::ostream & os, AuthorList const & a);
private:
///
Authors authors_;
};
bool operator==(Author const & l, Author const & r);
std::ostream & operator<<(std::ostream & os, Author const & a);
std::istream & operator>>(std::istream & os, Author & a);
} // namespace lyx
#endif // AUTHOR_H