The CiteInfoOption Class Reference

Declaration

class CiteInfoOption { ... }

Included Headers

#include <src/cite.h>

Enumerations Index

enum	Bits { ... }

Friends Index

bool	operator==
bool	operator!=

Public Constructors Index

	CiteInfoOption ()

Private Constructors Index

	CiteInfoOption (int bits)

Public Member Functions Index

void	changeToNumber ()
void	setNoPar ()
void	setNoCite ()
bool	isUnknown () const
bool	isNumber () const
bool	isShortAuthor () const
bool	isYear () const
bool	noPar () const
bool	noCite () const

Private Member Attributes Index

unsigned int	m_bits = UNKNOWN

Public Static Functions Index

static CiteInfoOption	makeNumber ()
static CiteInfoOption	makeShortAuthor ()
static CiteInfoOption	makeYear ()

Definition at line 25 of file cite.h.

Enumerations

Bits

enum CiteInfoOption::Bits

Enumeration values

UNKNOWN	(= 0)
NUMBER	(= (1<<0))
SHORTAUTHOR	(= (1<<1))
YEAR	(= (1<<2))
TypeMask	(= 0x0000FFFF)
OptionMask	(= 0xFFFF0000)
NOPAR_BIT	(= (1<<16))
NOCITE_BIT	(= (1<<17))

Definition at line 51 of file cite.h.

52 {

53 UNKNOWN = 0,

54 NUMBER = (1<<0),

55 SHORTAUTHOR = (1<<1),

56 YEAR = (1<<2),

57

58 TypeMask = 0x0000FFFF,

59 OptionMask = 0xFFFF0000,

60

61 NOPAR_BIT = (1<<16), //< Don't use square brackets

62 NOCITE_BIT = (1<<17) //< Don't create a link

63 };

Friends

operator!=

friend bool const CiteInfoOption & t1, const CiteInfoOption & t2

inline

Definition at line 46 of file cite.h.

46 friend inline bool operator!=(const CiteInfoOption &t1,const CiteInfoOption &t2) { return !(operator==(t1,t2)); }

References CiteInfoOption and operator==.

operator==

friend bool const CiteInfoOption & t1, const CiteInfoOption & t2

inline

Definition at line 45 of file cite.h.

45 friend inline bool operator==(const CiteInfoOption &t1,const CiteInfoOption &t2) { return t1.m_bits==t2.m_bits; }

References CiteInfoOption and m_bits.

Referenced by operator!=.

Public Constructors

CiteInfoOption()

CiteInfoOption::CiteInfoOption ()

inline

Definition at line 28 of file cite.h.

28 CiteInfoOption() {}

Referenced by makeNumber, makeShortAuthor, makeYear, operator!= and operator==.

Private Constructors

CiteInfoOption()

CiteInfoOption::CiteInfoOption (int bits)

inline

Definition at line 49 of file cite.h.

49 CiteInfoOption(int bits) : m_bits(bits) {}

Reference m_bits.

Public Member Functions

changeToNumber()

void CiteInfoOption::changeToNumber ()

inline

Definition at line 33 of file cite.h.

33 void changeToNumber() { m_bits = (m_bits & OptionMask) | NUMBER; }

References m_bits, NUMBER and OptionMask.

Referenced by DocPara::handleCite.

isNumber()

bool CiteInfoOption::isNumber ()

inline

Definition at line 38 of file cite.h.

38 bool isNumber() const { return (m_bits & NUMBER)!=0; }

References m_bits and NUMBER.

isShortAuthor()

bool CiteInfoOption::isShortAuthor ()

inline

Definition at line 39 of file cite.h.

39 bool isShortAuthor() const { return (m_bits & SHORTAUTHOR)!=0; }

References m_bits and SHORTAUTHOR.

isUnknown()

bool CiteInfoOption::isUnknown ()

inline

Definition at line 37 of file cite.h.

37 bool isUnknown() const { return (m_bits & TypeMask)==0; }

References m_bits and TypeMask.

Referenced by DocPara::handleCite.

isYear()

bool CiteInfoOption::isYear ()

inline

Definition at line 40 of file cite.h.

40 bool isYear() const { return (m_bits & YEAR)!=0; }

References m_bits and YEAR.

noCite()

bool CiteInfoOption::noCite ()

inline

Definition at line 43 of file cite.h.

43 bool noCite() const { return (m_bits & NOCITE_BIT)!=0; }

References m_bits and NOCITE_BIT.

noPar()

bool CiteInfoOption::noPar ()

inline

Definition at line 42 of file cite.h.

42 bool noPar() const { return (m_bits & NOPAR_BIT)!=0; }

References m_bits and NOPAR_BIT.

setNoCite()

void CiteInfoOption::setNoCite ()

inline

Definition at line 35 of file cite.h.

35 void setNoCite() { m_bits |= NOCITE_BIT; }

References m_bits and NOCITE_BIT.

Referenced by DocPara::handleCite.

setNoPar()

void CiteInfoOption::setNoPar ()

inline

Definition at line 34 of file cite.h.

34 void setNoPar() { m_bits |= NOPAR_BIT; }

References m_bits and NOPAR_BIT.

Referenced by DocPara::handleCite.

Private Member Attributes

m_bits

unsigned int CiteInfoOption::m_bits = UNKNOWN

Definition at line 64 of file cite.h.

64 unsigned int m_bits = UNKNOWN;

Referenced by changeToNumber, CiteInfoOption, isNumber, isShortAuthor, isUnknown, isYear, noCite, noPar, operator==, setNoCite and setNoPar.

Public Static Functions

makeNumber()

CiteInfoOption CiteInfoOption::makeNumber ()

inline static

Definition at line 29 of file cite.h.

29 static CiteInfoOption makeNumber() { return CiteInfoOption(NUMBER); }

References CiteInfoOption and NUMBER.

Referenced by DocPara::handleCite.

makeShortAuthor()

CiteInfoOption CiteInfoOption::makeShortAuthor ()

inline static

Definition at line 30 of file cite.h.

30 static CiteInfoOption makeShortAuthor() { return CiteInfoOption(SHORTAUTHOR); }

References CiteInfoOption and SHORTAUTHOR.

Referenced by DocPara::handleCite.

makeYear()

CiteInfoOption CiteInfoOption::makeYear ()

inline static

Definition at line 31 of file cite.h.

31 static CiteInfoOption makeYear() { return CiteInfoOption(YEAR); }

References CiteInfoOption and YEAR.

Referenced by DocPara::handleCite.

---

The documentation for this class was generated from the following file:

• cite.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.