Manage indexing of Nit model for Nitdoc QuickSearch.

Introduced classes

private class QuickSearchResult

nitc :: QuickSearchResult

A QuickSearch result.

private class QuickSearchTable

nitc :: QuickSearchTable

The result map for QuickSearch.

Redefined classes

redef abstract class Deserializer

nitc :: static_index $ Deserializer

Abstract deserialization service

redef class DocModel

nitc :: static_index $ DocModel

Generate the index for then Nitdoc QuickSearch field.

All class definitions

redef abstract class Deserializer

nitc :: static_index $ Deserializer

Abstract deserialization service

redef class DocModel

nitc :: static_index $ DocModel

Generate the index for then Nitdoc QuickSearch field.

private class QuickSearchResult

nitc $ QuickSearchResult

A QuickSearch result.

private class QuickSearchTable

nitc $ QuickSearchTable

The result map for QuickSearch.

Ancestors

module abstract_collection

core :: abstract_collection

Abstract collection classes and services.

module abstract_text

core :: abstract_text

Abstract class for manipulation of sequences of characters

module abstract_tree

trees :: abstract_tree

Introduce tree structures abstraction

module actors_injection_phase

nitc :: actors_injection_phase

Injects model for the classes annotated with "is actor" so

module annotation

nitc :: annotation

Management and utilities on annotations

module array

This module introduces the standard array structure.

module astbuilder

nitc :: astbuilder

Instantiation and transformation of semantic nodes in the AST of expressions and statements

module astutil

nitc :: astutil

Additional features on Nit AST

module auto_super_init

nitc :: auto_super_init

Computing of super-constructors that must be implicitly called at the begin of constructors.

module bintree

trees :: bintree

Binary Tree data-structure

module bitset

Services to handle BitSet

module bktree

trees :: bktree

Implementation of BKTree

module bootstrap

html :: bootstrap

HTML templates for Bootstrap components.

module bytes

Services for byte streams and arrays

module caching

serialization :: caching

Services for caching serialization engines

module catalog

nitc :: catalog

Basic catalog generator for Nit packages

module check_annotation

nitc :: check_annotation

Check that annotation present in the AST are either primitive or user-declared

module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.

module codec_base

core :: codec_base

Base for codecs to use with streams

module codecs

Group module for all codec-related manipulations

module collection

core :: collection

This module define several collection classes.

module commands_base

nitc :: commands_base

Documentation commands

module commands_catalog

nitc :: commands_catalog

Commands to retrieve Catalog related data

module commands_docdown

nitc :: commands_docdown

Doc down related queries

module commands_graph

nitc :: commands_graph

Graph commands

module commands_ini

nitc :: commands_ini

module commands_main

nitc :: commands_main

module commands_model

nitc :: commands_model

Doc commands about a Model or a MEntity

module commands_parser

nitc :: commands_parser

A parser that create DocCommand from a string

module commands_usage

nitc :: commands_usage

Commands about how mentities are used

module console

console :: console

Defines some ANSI Terminal Control Escape Sequences.

module core

Standard classes and methods used by default by Nit programs and libraries.

module counter

counter :: counter

Simple numerical statistical analysis and presentation

module deriving

nitc :: deriving

Injection of automatic method definitions for standard methods, based on the attributes of the classes

module digraph

graph :: digraph

Implementation of directed graphs, also called digraphs.

module div_by_zero

nitc :: div_by_zero

Detection of divisions by zero in obvious cases

module dot

Dot rendering library

module engine_tools

serialization :: engine_tools

Advanced services for serialization engines

module environ

core :: environ

Access to the environment variables of the process

module error

Standard error-management infrastructure.

module error

Intro JsonParseError which is exposed by all JSON reading APIs

module exec

Invocation and management of operating system sub-processes.

module file

File manipulations (create, read, write, etc.)

module fixed_ints

core :: fixed_ints

Basic integers of fixed-precision

module fixed_ints_text

core :: fixed_ints_text

Text services to complement fixed_ints

module flat

All the array-based text representations

module flow

Intraprocedural static flow.

module frontend

nitc :: frontend

Collect and orchestration of main frontend phases

module gc

Access to the Nit internal garbage collection mechanism

module glsl_validation

nitc :: glsl_validation

Check shader code within Nit modules using the tool glslangValidator

module hash_collection

core :: hash_collection

Introduce HashMap and HashSet.

module highlight

nitc :: highlight

Highlighting of Nit AST

module html

HTML output facilities

module html_commands

nitc :: html_commands

Render commands results as HTML

module html_model

nitc :: html_model

Translate mentities to html blocks.

module htmlight

nitc :: htmlight

Highlighting of Nit AST with HTML

module i18n_phase

nitc :: i18n_phase

Basic support of internationalization through the generation of id-to-string tables

module ini

Read and write INI configuration files

module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information

module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O

module json

Read and write JSON formatted text using the standard serialization services

module kernel

Most basic classes and methods.

module lexer

Lexer and its tokens.

module lexer_work

nitc :: lexer_work

Internal algorithm and data structures for the Nit lexer

module list

This module handle double linked lists

module literal

nitc :: literal

Parsing of literal values in the abstract syntax tree.

module loader

Loading of Nit source files

module local_var_init

nitc :: local_var_init

Verify that local variables are initialized before their usage

module location

nitc :: location

Nit source-file and locations in source-file

module markdown

markdown :: markdown

Markdown parsing.

module math

Mathematical operations

module md5

Native MD5 digest implementation as Text::md5

module md_commands

nitc :: md_commands

Render commands results as Markdown

module mdoc

Documentation of model entities

module meta

Simple user-defined meta-level to manipulate types of instances as object.

module mmodule

nitc :: mmodule

modules and module hierarchies in the metamodel

module mmodule_data

nitc :: mmodule_data

Define and retrieve data in modules

module model

Classes, types and properties

module model_base

nitc :: model_base

The abstract concept of model and related common things

module model_collect

nitc :: model_collect

Collect things from the model.

module model_examples

nitc :: model_examples

Examples for Model entities

module model_filters

nitc :: model_filters

module model_index

nitc :: model_index

Search things from the Model

module modelbuilder

nitc :: modelbuilder

module modelbuilder_base

nitc :: modelbuilder_base

Load nit source files and build the associated model

module modelize

nitc :: modelize

Create a model from nit source files

module modelize_class

nitc :: modelize_class

Analysis and verification of class definitions to instantiate model element

module modelize_property

nitc :: modelize_property

Analysis and verification of property definitions to instantiate model element

module more_collections

more_collections :: more_collections

Highly specific, but useful, collections-related classes.

module mpackage

nitc :: mpackage

Modelisation of a Nit package

module native

Native structures for text and bytes

module nitpm_shared

nitc :: nitpm_shared

Services related to the Nit package manager

module no_warning

nitc :: no_warning

Fill toolcontext information about blacklisting of warnings.

module numeric

core :: numeric

Advanced services for Numeric types

module opts

Management of options on the command line

module ordered_tree

ordered_tree :: ordered_tree

Manipulation and presentation of ordered trees.

module parallelization_phase

nitc :: parallelization_phase

Phase generating threads for functions annotated with threaded annotation

module parse_annotations

nitc :: parse_annotations

Simple annotation parsing

module parser

Parser.

module parser_base

parser_base :: parser_base

Simple base for hand-made parsers of all kinds

module parser_nodes

nitc :: parser_nodes

AST nodes of the Nit language

module parser_prod

nitc :: parser_prod

Production AST nodes full definition.

module parser_util

nitc :: parser_util

Utils and tools related to parsers and AST

module parser_work

nitc :: parser_work

Internal algorithm and data structures for the Nit parser

module phase

Phases of the processing of nit programs

module pipeline

pipeline :: pipeline

Pipelined filters and operations on iterators.

module poset

Pre order sets and partial order set (ie hierarchies)

module protocol

core :: protocol

module queue

Queuing data structures and wrappers

module range

Module for range of discrete objects.

module rbtree

trees :: rbtree

A red–black tree is a data structure which is a type of self-balancing binary search tree.

module re

Regular expression support for all services based on Pattern

module regex_phase

nitc :: regex_phase

Check for error in regular expressions from string literals

module ropes

Tree-based representation of a String.

module safe

serialization :: safe

Services for safer deserialization engines

module scope

Identification and scoping of local variables and labels.

module semantize

nitc :: semantize

Process bodies of methods in regard with the model.

module serialization

serialization :: serialization

General serialization services

module serialization_core

serialization :: serialization_core

Abstract services to serialize Nit objects to different formats

module serialization_model_phase

nitc :: serialization_model_phase

Phase generating methods (model-only) to serialize Nit objects

module serialization_read

json :: serialization_read

Services to read JSON: deserialize_json and JsonDeserializer

module serialization_write

json :: serialization_write

Services to write Nit objects to JSON strings: serialize_to_json and JsonSerializer

module simple_misc_analysis

nitc :: simple_misc_analysis

Simple vavious processing on a AST

module sorter

This module contains classes used to compare things and sorts arrays.

module static

Static interface to read Nit objects from JSON strings

module static_base

nitc :: static_base

Base entities shared by all the nitdoc code

module static_cards

nitc :: static_cards

Cards templates for the static documentation

module static_structure

nitc :: static_structure

Composes the pages of the static documentation

module stream

Input and output streams of characters

module string_search

core :: string_search

Basic string search, match and replace.

module tables

Module that interfaces the parsing tables.

module template

template :: template

Basic template system

module text

All the classes and methods related to the manipulation of text entities

module time

Management of time and dates

module toolcontext

nitc :: toolcontext

Common command-line tool infrastructure than handle options and error messages

module trees

General module for tree data structures

module trie

A trie (or prefix tree) is a datastructure used to perform prefix searches.

module typing

Intraprocedural resolution of static types and OO-services

module uml

Group head module for UML generation services

module uml_base

nitc :: uml_base

Exposes the base class for UML generation of a Model

module uml_class

nitc :: uml_class

Provides facilities of exporting a Model to a UML class diagram

module uml_module

nitc :: uml_module

Services for generation of a UML package diagram based on a Model

module union_find

core :: union_find

union–find algorithm using an efficient disjoint-set data structure

module utf8

Codec for UTF-8 I/O

module version

nitc :: version

This file was generated by git-gen-version.sh

module wikilinks

markdown :: wikilinks

Wikilinks handling.

Parents

module static_html

nitc :: static_html

Render documentation pages as HTML

Children

module static

Nitdoc generation framework

Descendants

module a_star-m

module nitdoc

Generator of static API documentation for the Nit language

# Manage indexing of Nit model for Nitdoc QuickSearch.
module static_index

import static::static_html
import json

# Generate the index for then Nitdoc QuickSearch field.
#
# Create a JSON object containing links to:
#  * mpackages
#  * modules
#  * mclasses
#  * mpropdefs
# All entities are grouped by name to make the research easier.
#
# TODO Merge with model_index
redef class DocModel

	# Build the nitdoc quick search index
	fun create_index_file(file: String) do
		var table = new QuickSearchTable(self)
		var tpl = new Template
		tpl.add "var nitdocQuickSearchRawList="
		tpl.add table.to_json
		tpl.add ";"
		tpl.write_to_file(file)
	end
end

# The result map for QuickSearch.
private class QuickSearchTable
	super HashMap[String, Array[QuickSearchResult]]

	var doc: DocModel

	init do
		var model = doc.model
		var filter = doc.filter

		index_mentities model.collect_mpackages(filter)
		index_mentities model.collect_mmodules(filter)
		index_mentities model.collect_mclasses(filter)
		index_mentities model.collect_mproperties(filter)
	end

	fun index_mentities(mentities: Collection[MEntity]) do
		for mentity in mentities do index_mentity mentity
	end

	fun index_mentity(mentity: MEntity) do
		var key = mentity.name
		if not has_key(key) then
			self[key] = new Array[QuickSearchResult]
		end
		self[key].add new QuickSearchResult(mentity.full_name, mentity.html_url)
	end
end

# A QuickSearch result.
private class QuickSearchResult
	serialize

	# The text of the link.
	var txt: String

	# The destination of the link.
	var url: String
end

src/doc/static/static_index.nit:15,1--82,3