#include <FrogAPI.h>

Public Member Functions
	FrogAPI (FrogOptions &, const TiCC::Configuration &, TiCC::LogStream , TiCC::LogStream )

	~FrogAPI ()

folia::Document *	FrogFile (const std::string &, std::ostream &)

void	FrogServer (Sockets::ClientSocket &conn)

void	FrogInteractive ()

frog_data	frog_sentence (std::vector< Tokenizer::Token > &, const size_t)

std::string	Frogtostring (const std::string &)

std::string	Frogtostringfromfile (const std::string &)

void	run_api_tests (const std::string &, std::ostream &)

Static Public Member Functions
static std::string	defaultConfigDir (const std::string &="")

static std::string	defaultConfigFile (const std::string &="")

Detailed Description

This is the API class which can be used to set up Frog and run it on files, strings, TCP sockets or a terminal.

Constructor & Destructor Documentation

◆ FrogAPI()

FrogAPI::FrogAPI	(	FrogOptions &	,
		const TiCC::Configuration &	,
		TiCC::LogStream *	,
		TiCC::LogStream *
	)

◆ ~FrogAPI()

FrogAPI::~FrogAPI ( )

Member Function Documentation

◆ defaultConfigDir()

string FrogAPI::defaultConfigDir ( const std::string & language = "" )

static

return the default location of the configuration files

Parameters

language use this to find the configuration for this language

Returns: a string representing the (language specific) path

The location of the configuration files is determined at installation of the package. All languages are supposed to be in sub-directories

◆ defaultConfigFile()

string FrogAPI::defaultConfigFile ( const std::string & language = "" )

static

return the filename for the default configuration

Parameters

language use this to find the configuration for this language

Returns: a string representing (language specific) default filename

The location of the configuration files is determined at installation of the package. All languages are supposed to be in sub-directories

◆ frog_sentence()

frog_data FrogAPI::frog_sentence	(	std::vector< Tokenizer::Token > &	,
		const	size_t
	)

◆ FrogFile()

folia::Document* FrogAPI::FrogFile	(	const std::string &	,
		std::ostream &
	)

◆ FrogInteractive()

void FrogAPI::FrogInteractive ( )

◆ FrogServer()

void FrogAPI::FrogServer ( Sockets::ClientSocket & conn )

◆ Frogtostring()

std::string FrogAPI::Frogtostring ( const std::string & )

◆ Frogtostringfromfile()

std::string FrogAPI::Frogtostringfromfile ( const std::string & )

◆ run_api_tests()

void FrogAPI::run_api_tests	(	const std::string &	,
		std::ostream &
	)

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

include/frog/FrogAPI.h
src/FrogAPI.cxx

Public Member Functions

Static Public Member Functions