Freeciv-3.2
Loading...
Searching...
No Matches
Functions | Variables
fc_manual.c File Reference
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include "capability.h"
#include "fc_cmdline.h"
#include "fciconv.h"
#include "fcintl.h"
#include "log.h"
#include "mem.h"
#include "registry.h"
#include "capstr.h"
#include "connection.h"
#include "fc_cmdhelp.h"
#include "fc_interface.h"
#include "version.h"
#include "client_main.h"
#include "climisc.h"
#include "helpdata.h"
#include "music.h"
#include "tilespec.h"
#include "ruleset.h"
#include "settings.h"
#include "sernet.h"
#include "srv_main.h"
#include "stdinhand.h"
#include "tools_fc_interface.h"
#include "fc_manual.h"

Go to the source code of this file.

Functions

void insert_client_build_info (char *outbuf, size_t outlen)
 
charhtml_special_chars (char *str, size_t *len)
 
void popup_help_dialog_string (const char *item)
 
void popdown_help_dialog (void)
 
const chartileset_name_get (struct tileset *t)
 
const chartileset_version (struct tileset *t)
 
const chartileset_summary (struct tileset *t)
 
const chartileset_description (struct tileset *t)
 
const charcurrent_musicset_name (void)
 
const charcurrent_musicset_version (void)
 
const charcurrent_musicset_summary (void)
 
const charcurrent_musicset_description (void)
 
enum client_states client_state (void)
 
bool client_nation_is_in_current_set (const struct nation_type *pnation)
 
FILEmanual_start (struct tag_types *tag_info, int manual_number)
 
void manual_finalize (struct tag_types *tag_info, FILE *doc, enum manuals manual)
 
static bool manual_command (struct tag_types *tag_info)
 
int main (int argc, char **argv)
 

Variables

struct tag_types html_tags
 
struct tag_types wiki_tags
 
const charclient_string = "freeciv-manual"
 
static charruleset = NULL
 
struct tilesettileset
 

Function Documentation

◆ client_nation_is_in_current_set()

bool client_nation_is_in_current_set ( const struct nation_type pnation)

Mostly a client stub.

Definition at line 273 of file fc_manual.c.

◆ client_state()

enum client_states client_state ( void  )

Mostly a client stub.

Definition at line 265 of file fc_manual.c.

◆ current_musicset_description()

const char * current_musicset_description ( void  )

Client stub

Definition at line 257 of file fc_manual.c.

◆ current_musicset_name()

const char * current_musicset_name ( void  )

Client stub

Definition at line 233 of file fc_manual.c.

◆ current_musicset_summary()

const char * current_musicset_summary ( void  )

Client stub

Definition at line 249 of file fc_manual.c.

◆ current_musicset_version()

const char * current_musicset_version ( void  )

Client stub

Definition at line 241 of file fc_manual.c.

◆ html_special_chars()

char * html_special_chars ( char str,
size_t len 
)

Replace html special characters ('&', '<' and '>').

Definition at line 164 of file fc_manual.c.

Referenced by manual_commands(), and manual_settings().

◆ insert_client_build_info()

void insert_client_build_info ( char outbuf,
size_t  outlen 
)

Empty function required by helpdata

Definition at line 505 of file fc_manual.c.

◆ main()

int main ( int  argc,
char **  argv 
)

Entry point of whole freeciv-manual program

Definition at line 355 of file fc_manual.c.

◆ manual_command()

static bool manual_command ( struct tag_types tag_info)
static

Write a server manual, then quit.

Definition at line 328 of file fc_manual.c.

Referenced by main().

◆ manual_finalize()

void manual_finalize ( struct tag_types tag_info,
FILE doc,
enum manuals  manual 
)

Generic finalizing step for a manual page. Closes the file.

Parameters
tag_infoTag set to use
docManual handle
manual_nameName of the manual

Definition at line 316 of file fc_manual.c.

Referenced by manual_commands(), manual_extras(), manual_governments(), manual_improvements(), manual_settings(), manual_techs(), manual_terrain(), and manual_units().

◆ manual_start()

FILE * manual_start ( struct tag_types tag_info,
int  manual_number 
)

Create manual file, and do the generic header for it.

Parameters
tag_infoTag set to use
manual_numberNumber of the manual page
Returns
Handle of the created file

Definition at line 287 of file fc_manual.c.

Referenced by manual_commands(), manual_extras(), manual_governments(), manual_improvements(), manual_settings(), manual_techs(), manual_terrain(), and manual_units().

◆ popdown_help_dialog()

void popdown_help_dialog ( void  )

Client stub

Definition at line 191 of file fc_manual.c.

◆ popup_help_dialog_string()

void popup_help_dialog_string ( const char item)

Client stub

Definition at line 183 of file fc_manual.c.

◆ tileset_description()

const char * tileset_description ( struct tileset t)

Client stub

Definition at line 225 of file fc_manual.c.

◆ tileset_name_get()

const char * tileset_name_get ( struct tileset t)

Client stub

Definition at line 201 of file fc_manual.c.

◆ tileset_summary()

const char * tileset_summary ( struct tileset t)

Client stub

Definition at line 217 of file fc_manual.c.

◆ tileset_version()

const char * tileset_version ( struct tileset t)

Client stub

Definition at line 209 of file fc_manual.c.

Variable Documentation

◆ client_string

const char* client_string = "freeciv-manual"

Definition at line 157 of file fc_manual.c.

◆ html_tags

struct tag_types html_tags

Definition at line 63 of file fc_manual.c.

Referenced by main().

◆ ruleset

char* ruleset = NULL
static

◆ tileset

Definition at line 196 of file fc_manual.c.

◆ wiki_tags

struct tag_types wiki_tags

Definition at line 109 of file fc_manual.c.

Referenced by main().