fdoc

Derived Types

TypeLocationExtendsDescription
adjacency_t

Each direction of one relation, for each entity.

args_t

The parsed command line.

association_t

A name given by an associate statement.

attribute_t

An attribute given in a statement of its own, such as public :: x, waiting to be applied.

block_t

The parts of a directive.

body_t

The nodes of a block.

buffer_t

Text being built.

doc_lines_t

Documentation lines of one item.

entity_box_t

Holds an entity, so that it can be moved without being copied.

entity_list_t

A list of entities. Indices start at 1, and 0 means no entity.

entity_more_t

What only some entities have. Most entities are variables, which share one of these, so an entity takes half the memory; this makes up most of the memory used on large projects.

entity_t

A file, program unit, procedure, type, variable or the like. Which components apply depends on kind.

expr_t

An expression, compiled.

file_stats_t

The size of a source file, or of several.

file_type_t

An extra_filetypes entry.

footnote_t

A footnote definition.

frame_t

Local variables.

fypp_t

The state of processing a file.

graph_job_t

A graph waiting to be drawn.

graph_set_t

The graphs of a project.

graph_t

A graph of a page.

heading_t

A heading, for the table of contents.

index_list_t

Entities, by index.

int_list_t

A list of entities.

label_list_t

Labels of edges.

link_context_t

Where a [[name]] link is being read.

macro_t

A macro.

map_entry_t

A key and its value.

markdown_options_t

What rendering depends on.

meta_item_t

A metadata key and the values given for it.

meta_t

A metadata entry of a doc comment, such as author: me.

metadata_t

The metadata of a project file and what follows it.

name_index_t

A hash table from names to positive integers, for lookups in long lists.

node_t

A piece of the document.

node_t

An element of the tree.

option_t

An option given on the command line, in the form set_option takes.

page_t

A static page.

parsed_type_t

The type part of a declaration.

procedure_header_t

The parts of a subroutine or function statement.

project_t

The parsed project.

reference_t

A link reference definition.

rename_t

A name in the only list of a use statement.

scan_t

Reading an expression.

settings_t

The project settings. Optional text options are not allocated unless set.

site_t

What every page needs.

span_t

Where a result of evaluation is in the output.

symbol_list_t

Names, in the order they were added, with an index.

symbol_t

An entity under the name it is known by in some scope.

symbols_t

The names a module makes public, by category.

tree_t

The state of one conversion.

use_t

A use statement.

value_t

A Python value.

walk_t

The working space of one thread, sized once, for finding what a graph holds.

Type graph

buffer_toption_targs_toptionsparsed_type_tprocedure_header_tvalue_titemsexpr_tvaluescan_tbody_tblock_tbodiesnode_tblockmacro_tdefaults, valuesframe_tvaluesspan_tfypp_tglobals, bound_valuesexprsnodesmacrosframesspansname_index_tcompiledint_list_tlabel_list_tadjacency_tout, inlabelsgraph_tgraph_set_tgraphsgraph_job_twalk_tmarkdown_options_tmap_entry_taliases, abbreviationsnode_treference_tfootnote_theading_ttree_tnodesrefsnotesheadingsabbreviationsattribute_trename_tuse_trenamesmeta_tentity_more_tpending, parametersusesentity_tmetamoreentity_box_teentity_list_tboxnamespage_tassociation_tdoc_lines_tsymbol_tsymbol_list_tsindexsymbols_tprocs, absints, types, varspublic_listproject_tlistpubmeta_item_tmetadata_titemsfile_type_tsettings_talias, external, extra_modsextra_filetypesindex_list_tsite_tgraphspagespsmembers, graphs_offile_stats_tfile_statslink_context_tlist