Doxygen
Loading...
Searching...
No Matches
CiteInfoOption Class Reference

#include <src/cite.h>

Public Member Functions

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

Static Public Member Functions

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

Private Types

enum  Bits {
  UNKNOWN = 0 , NUMBER = (1<<0) , SHORTAUTHOR = (1<<1) , YEAR = (1<<2) ,
  TypeMask = 0x0000FFFF , OptionMask = 0xFFFF0000 , NOPAR_BIT = (1<<16) , NOCITE_BIT = (1<<17)
}

Private Member Functions

constexpr CiteInfoOption (int bits)

Private Attributes

unsigned int m_bits = UNKNOWN

Friends

bool operator== (const CiteInfoOption &t1, const CiteInfoOption &t2)
bool operator!= (const CiteInfoOption &t1, const CiteInfoOption &t2)

Detailed Description

Definition at line 25 of file cite.h.

Member Enumeration Documentation

◆ Bits

enum CiteInfoOption::Bits
private
Enumerator
UNKNOWN 
NUMBER 
SHORTAUTHOR 
YEAR 
TypeMask 
OptionMask 
NOPAR_BIT 
NOCITE_BIT 

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 };
CiteInfoOption::SHORTAUTHOR
@ SHORTAUTHOR
Definition cite.h:55

Constructor & Destructor Documentation

◆ CiteInfoOption() [1/2]

CiteInfoOption::CiteInfoOption ( )
inlineconstexpr

Definition at line 28 of file cite.h.

28{}

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

◆ CiteInfoOption() [2/2]

CiteInfoOption::CiteInfoOption ( int bits)
inlineconstexprprivate

Definition at line 49 of file cite.h.

49: m_bits(bits) {}
CiteInfoOption::m_bits
unsigned int m_bits
Definition cite.h:64

References m_bits.

Member Function Documentation

◆ changeToNumber()

void CiteInfoOption::changeToNumber ( )
inlineconstexprnoexcept

Definition at line 33 of file cite.h.

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

References m_bits, NUMBER, and OptionMask.

Referenced by DocPara::handleCite().

◆ isNumber()

bool CiteInfoOption::isNumber ( ) const
inlineconstexprnoexcept

Definition at line 38 of file cite.h.

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

References m_bits, and NUMBER.

◆ isShortAuthor()

bool CiteInfoOption::isShortAuthor ( ) const
inlineconstexprnoexcept

Definition at line 39 of file cite.h.

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

References m_bits, and SHORTAUTHOR.

◆ isUnknown()

bool CiteInfoOption::isUnknown ( ) const
inlineconstexprnoexcept

Definition at line 37 of file cite.h.

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

References m_bits, and TypeMask.

Referenced by DocPara::handleCite().

◆ isYear()

bool CiteInfoOption::isYear ( ) const
inlineconstexprnoexcept

Definition at line 40 of file cite.h.

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

References m_bits, and YEAR.

◆ makeNumber()

constexpr CiteInfoOption CiteInfoOption::makeNumber ( )
inlinestaticconstexpr

Definition at line 29 of file cite.h.

29{ return CiteInfoOption(NUMBER); }
CiteInfoOption::CiteInfoOption
constexpr CiteInfoOption()
Definition cite.h:28

References CiteInfoOption(), and NUMBER.

Referenced by DocPara::handleCite().

◆ makeShortAuthor()

constexpr CiteInfoOption CiteInfoOption::makeShortAuthor ( )
inlinestaticconstexpr

Definition at line 30 of file cite.h.

30{ return CiteInfoOption(SHORTAUTHOR); }

References CiteInfoOption(), and SHORTAUTHOR.

Referenced by DocPara::handleCite().

◆ makeYear()

constexpr CiteInfoOption CiteInfoOption::makeYear ( )
inlinestaticconstexpr

Definition at line 31 of file cite.h.

31{ return CiteInfoOption(YEAR); }

References CiteInfoOption(), and YEAR.

Referenced by DocPara::handleCite().

◆ noCite()

bool CiteInfoOption::noCite ( ) const
inlineconstexprnoexcept

Definition at line 43 of file cite.h.

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

References m_bits, and NOCITE_BIT.

◆ noPar()

bool CiteInfoOption::noPar ( ) const
inlineconstexprnoexcept

Definition at line 42 of file cite.h.

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

References m_bits, and NOPAR_BIT.

◆ setNoCite()

void CiteInfoOption::setNoCite ( )
inlineconstexprnoexcept

Definition at line 35 of file cite.h.

35{ m_bits |= NOCITE_BIT; }

References m_bits, and NOCITE_BIT.

Referenced by DocPara::handleCite().

◆ setNoPar()

void CiteInfoOption::setNoPar ( )
inlineconstexprnoexcept

Definition at line 34 of file cite.h.

34{ m_bits |= NOPAR_BIT; }

References m_bits, and NOPAR_BIT.

Referenced by DocPara::handleCite().

◆ operator!=

bool operator!= ( const CiteInfoOption & t1,
const CiteInfoOption & t2 )
friend

Definition at line 46 of file cite.h.

46{ return !(operator==(t1,t2)); }
CiteInfoOption::operator==
friend bool operator==(const CiteInfoOption &t1, const CiteInfoOption &t2)
Definition cite.h:45

References CiteInfoOption(), and operator==.

◆ operator==

bool operator== ( const CiteInfoOption & t1,
const CiteInfoOption & t2 )
friend

Definition at line 45 of file cite.h.

45{ return t1.m_bits==t2.m_bits; }

References CiteInfoOption(), and m_bits.

Referenced by operator!=.

Member Data Documentation

◆ m_bits

unsigned int CiteInfoOption::m_bits = UNKNOWN
private

Definition at line 64 of file cite.h.

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

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