NCBI C++ ToolKit
Public Member Functions | Protected Member Functions | Static Private Member Functions | Private Attributes | List of all members
CCgiEntries_Parser Class Reference

Search Toolkit Book for CCgiEntries_Parser

#include "cgi_impl.hpp"
(Private to src/cgi.)

+ Inheritance diagram for CCgiEntries_Parser:
+ Collaboration diagram for CCgiEntries_Parser:

Public Member Functions

 CCgiEntries_Parser (TCgiEntries *entries, TCgiIndexes *indexes, CCgiRequest::TFlags flags)
- Public Member Functions inherited from CUrlArgs_Parser
 CUrlArgs_Parser (TFlags flags=0)
virtual ~CUrlArgs_Parser (void)
void SetQueryString (const string &query, NStr::EUrlEncode encode)
 Parse query string, call AddArgument() to store each value. More...
void SetQueryString (const string &query, const IUrlEncoder *encoder=0)
 Parse query string, call AddArgument() to store each value. More...
void SetSemicolonIsNotArgDelimiter (bool enable=true)
 Treat semicolon as query string argument separator. More...

Protected Member Functions

virtual void AddArgument (unsigned int position, const string &name, const string &value, EArgType arg_type)
 Process next query argument. More...

Static Private Member Functions

static CCgiRequest::TFlags TFlagsToCCgiRequestTFlags (TFlags flags)
static TFlags CCgiRequestTFlagsToTFlags (CCgiRequest::TFlags flags)

Private Attributes


Additional Inherited Members

- Public Types inherited from CUrlArgs_Parser
enum  Flags { fSemicolonIsArgDelimiter = (1 << 11) , fEnableParsingAsIndex = (1 << 14) }
typedef int TFlags
 An inverted subset of CCgiRequest::TFlags. More...
- Protected Types inherited from CUrlArgs_Parser
enum  EArgType { eArg_Value , eArg_Index }
 Query type flag. More...
- Protected Attributes inherited from CUrlArgs_Parser
TFlags m_Flags

Detailed Description

Definition at line 37 of file cgi_impl.hpp.

Constructor & Destructor Documentation

◆ CCgiEntries_Parser()

CCgiEntries_Parser::CCgiEntries_Parser ( TCgiEntries entries,
TCgiIndexes indexes,
CCgiRequest::TFlags  flags 

Definition at line 971 of file ncbicgi.cpp.

Member Function Documentation

◆ AddArgument()

void CCgiEntries_Parser::AddArgument ( unsigned int  position,
const string name,
const string value,
EArgType  arg_type 

Process next query argument.

Must be overriden to process and store the arguments.

position1-based index of the argument in the query.
nameName of the argument.
valueContains argument value if query type is eArg_Value or empty string for eArg_Index.
arg_typeQuery type flag.

Implements CUrlArgs_Parser.

Definition at line 982 of file ncbicgi.cpp.

References _ASSERT, CUrlArgs_Parser::eArg_Value, CCgiRequest::fIndexesNotEntries, multimap_checker< Container >::insert(), kEmptyStr, m_Entries, CUrlArgs_Parser::m_Flags, m_Indexes, TFlagsToCCgiRequestTFlags(), and rapidjson::value.

◆ CCgiRequestTFlagsToTFlags()

static TFlags CCgiEntries_Parser::CCgiRequestTFlagsToTFlags ( CCgiRequest::TFlags  flags)

Definition at line 50 of file cgi_impl.hpp.

References flags.

◆ TFlagsToCCgiRequestTFlags()

static CCgiRequest::TFlags CCgiEntries_Parser::TFlagsToCCgiRequestTFlags ( TFlags  flags)

Definition at line 49 of file cgi_impl.hpp.

References flags.

Referenced by AddArgument().

Member Data Documentation

◆ m_Entries

TCgiEntries* CCgiEntries_Parser::m_Entries

Definition at line 52 of file cgi_impl.hpp.

Referenced by AddArgument().

◆ m_Indexes

TCgiIndexes* CCgiEntries_Parser::m_Indexes

Definition at line 53 of file cgi_impl.hpp.

Referenced by AddArgument().

The documentation for this class was generated from the following files:
Modified on Tue Apr 16 20:13:03 2024 by rev. 669887