Base for codecs to use with streams

A Codec (Coder/Decoder) is a tranformer from a byte-format to another

As Nit Strings are UTF-8, a codec works as :

Coder: From a UTF-8 string to a specified format (writing)
Decoder: From a specified format to a UTF-8 string (reading)

Introduced classes

abstract class Codec

Codes/Decodes entities from/to UTF-8

All class definitions

abstract class Codec

Codes/Decodes entities from/to UTF-8

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 array

This module introduces the standard array structure.

module circular_array

core :: circular_array

Efficient data structure to access both end of the sequence.

module collection

core :: collection

This module define several collection classes.

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 hash_collection

core :: hash_collection

Introduce HashMap and HashSet.

module kernel

Most basic classes and methods.

module list

This module handle double linked lists

module math

Mathematical operations

module native

Native structures for text and bytes

module range

Module for range of discrete objects.

module ropes

Tree-based representation of a String.

module sorter

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

module string_search

core :: string_search

Basic string search, match and replace.

module union_find

core :: union_find

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

Parents

module bytes

Services for byte streams and arrays

module text

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

Children

module iso8859_1

core :: iso8859_1

Codec for ISO8859-1 I/O

module utf8

Codec for UTF-8 I/O

Descendants

module a_star

a_star :: a_star

A* pathfinding in graphs

module a_star-m

module abstract_compiler

nitc :: abstract_compiler

Abstract compiler

module abstract_tree

trees :: abstract_tree

Introduce tree structures abstraction

module activities

android :: activities

Android Activities wrapper

module actors

actors :: actors

Abstraction of the actors concepts

module actors_generation_phase

nitc :: actors_generation_phase

Generate a support module for each module that contain a class annotated with is actor

module actors_injection_phase

nitc :: actors_injection_phase

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

module agent_simulation

actors :: agent_simulation

a "Framework" to make Multi-Agent Simulations in Nit

module ai

ai :: ai

Simple toolkit for artificial intelligence.

module all

Unites the main sdl2 module and its sister library sdl2::image

module android

android :: android

Android services and implementation of app.nit

module android

nitc :: android

Compile program for the Android platform

module android19

gamnit :: android19

Variation using features from Android API 19

module android_annotations

nitc :: android_annotations

Additionnal annotations to gather metadata on Android projects

module angles

geometry :: angles

Angle related service using Float to represent an angle in radians

module annotation

nitc :: annotation

Management and utilities on annotations

module api

Components required to build a web server about the nit model.

module api

Nit object oriented interface to Github api.

module api_auth

nitc :: api_auth

module api_base

nitc :: api_base

Base classes used by nitweb.

module api_docdown

nitc :: api_docdown

Nitdoc specific Markdown format handling for Nitweb

module api_feedback

nitc :: api_feedback

Feedback related features

module api_light

nitc :: api_light

Highlight and collect messages from a piece of code

module api_metrics

nitc :: api_metrics

module api_model

nitc :: api_model

module app

Basic structure for Nit apps on iOS

module app

app.nit is a framework to create cross-platform applications

module app_annotations

nitc :: app_annotations

Annotations to gather metadata on app.nit projects

module app_base

app :: app_base

Base of the app.nit framework, defines App

module app_kit

cocoa :: app_kit

The Application Kit provides services to create GUI

module array_debug

array_debug :: array_debug

Exposes functions to help profile or debug Arrays.

module assets

android :: assets

Implementation of app::assets

module assets

Implementation of app::assets

module assets

Portable services to load resources from the assets folder

module assets_and_resources

android :: assets_and_resources

Android Assets and Resources Management

module ast_metrics

nitc :: ast_metrics

Metrics about the nodes and identifiers in the AST

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 at_boot

android :: at_boot

Import this module to launch Service at device boot

module attributes

sax :: attributes

Interface for a list of XML attributes.

module attributes_impl

sax :: attributes_impl

Default implementation of the Attributes interface.

module audio

Services to load and play Sound and Music from the assets folder

module audio

app::audio implementation for GNU/Linux using SDL2 mixer

module audio

iOS implementation of app::audio using AVAudioPlayer

module audio

android :: audio

Android audio services, wraps a part of android audio API

module auto_super_init

nitc :: auto_super_init

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

module aware

android :: aware

Android compatibility module

module backtrack

ai :: backtrack

Basic framework for active backtrack solver

module base64

base64 :: base64

Offers the base 64 encoding and decoding algorithms

module basic_ciphers

crypto :: basic_ciphers

Basic cryptographic ciphers and utilities.

module bcm2835

bcm2835 :: bcm2835

Services to control the bcm2835 chipset used in the Raspberry Pi

module binary

binary :: binary

Read and write binary data with any Reader and Writer

module bintree

trees :: bintree

Binary Tree data-structure

module bitmap

bitmap :: bitmap

The Bitmap class represents a 24-bit bitmap image. An instance can be constructed

module bktree

trees :: bktree

Implementation of BKTree

module blink

bcm2835 :: blink

module bmfont

gamnit :: bmfont

Parse Angel Code BMFont format and draw text

module bootstrap

html :: bootstrap

HTML templates for Bootstrap components.

module boxes

geometry :: boxes

Provides interfaces and classes to represent basic geometry needs.

module bucketed_game

bucketed_game :: bucketed_game

Game framework with an emphasis on efficient event coordination

module bundle

android :: bundle

A mapping class of String to various value types used by the

module bytes

crypto :: bytes

Mix of utilities and services related to bytes

module c

c :: c

Structures and services for compatibility with the C language

module c

Support for nesting C code within a Nit program using its FFI

module c_compiler_options

nitc :: c_compiler_options

Offers the annotations cflags and ldflags to specify

module c_tools

nitc :: c_tools

provides tools to write C .c and .h files

module cache

github :: cache

Enable caching on Github API accesses.

module caching

serialization :: caching

Services for caching serialization engines

module camera_control

gamnit :: camera_control

Simple camera control for user, as the method accept_scroll_and_zoom

module camera_control_android

gamnit :: camera_control_android

Two fingers camera manipulation, pinch to zoom and slide to scroll

module camera_control_linux

gamnit :: camera_control_linux

Mouse wheel and middle mouse button to control camera

module cameras

gamnit :: cameras

Camera services producing Model-View-Projection matrices

module cameras_cache

gamnit :: cameras_cache

Cache the Matrix produced by Camera::mvp_matrix

module cardboard

android :: cardboard

Services from the Google Cardboard SDK for virtual reality on Android

module cardboard

gamnit :: cardboard

Update the orientation of world_camera at each frame using the head position given by android::cardboard

module cartesian

cartesian :: cartesian

Memory-efficient Cartesian products on heterogeneous collections.

module catalog

nitc :: catalog

Basic catalog generator for Nit packages

module chameneosredux

actors :: chameneosredux

Example implemented from "The computer Language Benchmarks Game" - Chameneos-Redux

module check_annotation

nitc :: check_annotation

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

module checker

Simple XML validity checker using the dom module

module client

gamnit :: client

Client-side network services for games and such

module clusters

dot :: clusters

Example from http://www.graphviz.org/content/cluster

module cocoa

Cocoa API, the development layer of OS X

module cocoa_extern_types

cocoa :: cocoa_extern_types

Test extern classes from the Cocoa framework and extern factories

module cocoa_message_box

cocoa :: cocoa_message_box

Simple message box using the Cocoa framework

module code_gen

nitc :: code_gen

Main frontend phases plus code generation phases

module codecs

Group module for all codec-related manipulations

module codesmells_metrics

nitc :: codesmells_metrics

module collections

java :: collections

Basic Java collections

module coloring

nitc :: coloring

module combinations

combinations :: combinations

Memory-efficient Cartesian products, combinations and permutation on collections.

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_http

nitc :: commands_http

Initialize commands from HTTP requests

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 common

gamnit :: common

Services common to the client and server modules

module commonmark_gen

markdown2 :: commonmark_gen

Generate Nitunit tests from commonmark specification.

module compilation

nitc :: compilation

The compilation module of the VirtualMachine

module compiler

nitc :: compiler

Compilation to C

module compiler_ffi

nitc :: compiler_ffi

Full FFI support for the compiler

module compiler_serialization

nitc :: compiler_serialization

Serialization support for the compiler

module concurrent_array_and_barrier

pthreads :: concurrent_array_and_barrier

A basic usage example of the modules pthreads and pthreads::cocurrent_collections

module concurrent_collections

pthreads :: concurrent_collections

Introduces thread-safe concurrent collections

module config

config :: config

Configuration options for nit tools and apps

module console

console :: console

Defines some ANSI Terminal Control Escape Sequences.

module content_handler

sax :: content_handler

Receives notification of the logical content of a document.

module contracts

nitc :: contracts

Module to build contract

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 cpp

Services for compatibility with C++ code and libraries

module cpp

Supports the use of the C++ language through the FFI

module crapto

crapto :: crapto

Cryptographic attacks and utilities.

module crypto

crypto :: crypto

Mix of all things cryptography-related

module csv

CSV document handling.

module curl

Data transfer powered by the native curl library

module curl_http

curl :: curl_http

Example use of the Curl module

module curl_json

neo4j :: curl_json

cURL requests compatible with the JSON REST APIs.

module curl_rest

curl :: curl_rest

module curses

curses :: curses

Curses for Nit

module custom_serialization

serialization :: custom_serialization

Example of an ad hoc serializer that is tailored to transform business specific objects into customized representation.

module dalvik

android :: dalvik

Java related services specific to Android and its Dalvik VM

module data_store

linux :: data_store

app::data_store implementation on GNU/Linux

module data_store

app :: data_store

Key/value storage services

module data_store

ios :: data_store

Implements app::data_store using NSUserDefaults

module data_store

android :: data_store

Implements app::data_store using shared_preferences

module date

Services to manipulate Date, Time and DateTime

module decl_handler

sax :: decl_handler

SAX2 extension handler for DTD declaration events.

module decorators

markdown :: decorators

Decorators for markdown parsing.

module depth

gamnit :: depth

Framework for 3D games in Nit

module depth_core

gamnit :: depth_core

Base entities of the depth 3D game framework

module deriving

deriving :: deriving

Automatic derivable implementations of standard basic methods.

module deriving

nitc :: deriving

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

module detect_covariance

nitc :: detect_covariance

Detect the static usage of covariance in the code.

module detect_variance_constraints

nitc :: detect_variance_constraints

Collect metrics about detected variances constraints on formal types.

module digraph

graph :: digraph

Implementation of directed graphs, also called digraphs.

module display

gamnit :: display

Abstract display services

module display_android

gamnit :: display_android

Gamnit display implementation for Android

module display_ios

gamnit :: display_ios

Gamnit display implementation for iOS

module display_linux

gamnit :: display_linux

Gamnit display implementation for GNU/Linux using egl, sdl and x11

module div_by_zero

nitc :: div_by_zero

Detection of divisions by zero in obvious cases

module dom

Easy XML DOM parser

module dot

Dot rendering library

module drop_privileges

privileges :: drop_privileges

Example using the privileges module to drop privileges from root

module dtd_handler

sax :: dtd_handler

Receives notification of basic DTD-related events.

module dummy_array

dummy_array :: dummy_array

module dynamic

json :: dynamic

Dynamic interface to read values from JSON strings

module dynamic_loading_ffi

nitc :: dynamic_loading_ffi

Execute FFI code by creating and loading shared libraries

module dynamic_resolution

gamnit :: dynamic_resolution

Virtual screen with a resolution independent from the real screen

module egl

Interface between rendering APIs (OpenGL, OpenGL ES, etc.) and the native windowing system.

module egl

Use of EGL to implement Gamnit on GNU/Linux and Android

module emscripten

nitc :: emscripten

Compile to JavaScript using the Emscripten SDK

module emscripten

emscripten :: emscripten

Platform for the emscripten framework

module engine_tools

serialization :: engine_tools

Advanced services for serialization engines

module english_utils

crapto :: english_utils

English language utilities for cryptographic purposes.

module entity_resolver

sax :: entity_resolver

Basic interface for resolving entities.

module environ

core :: environ

Access to the environment variables of the process

module error

Intro JsonParseError which is exposed by all JSON reading APIs

module error

Errors thrown by the neo4j library.

module error_handler

sax :: error_handler

Basic interface for SAX error handlers.

module event_queue

event_queue :: event_queue

Register, update and discard events in a timeline.

module events

SDL 2 events and related services

module events

github :: events

Events are emitted by Github Hooks.

module example_advanced_logger

popcorn :: example_advanced_logger

module example_angular

popcorn :: example_angular

This is an example of how to use angular.js with popcorn

module example_glob_route

popcorn :: example_glob_route

module example_hello

popcorn :: example_hello

module example_html_error_handler

popcorn :: example_html_error_handler

module example_mongodb

popcorn :: example_mongodb

module example_param_route

popcorn :: example_param_route

module example_post_handler

popcorn :: example_post_handler

module example_query_string

popcorn :: example_query_string

module example_router

popcorn :: example_router

module example_session

popcorn :: example_session

module example_simple_error_handler

popcorn :: example_simple_error_handler

module example_simple_logger

popcorn :: example_simple_logger

module example_static

popcorn :: example_static

module example_static_default

popcorn :: example_static_default

module example_static_multiple

popcorn :: example_static_multiple

module example_templates

popcorn :: example_templates

module example_vsm

vsm :: example_vsm

Example using a FileIndex

module exec

Invocation and management of operating system sub-processes.

module explain_assert

nitc :: explain_assert

Explain failed assert to the console by modifying the AST.

module explain_assert_api

nitc :: explain_assert_api

Explain failed assert to the console (service declaration only)

module ext

Services not defined in POSIX but provided by most implementations

module ext

Interfaces to optional SAX2 handlers.

module ext

Application specific MessagePack extension MsgPackExt

module extern_classes

nitc :: extern_classes

Manages all extern classes and their associated foreign type.

module extra

Shortcut services for scripts: http_get and http_download

module extra

pthreads :: extra

Offers some POSIX threads services that are not available on all platforms

module extra_java_files

nitc :: extra_java_files

Intro the annotation extra_java_files to compile extra java files

module fannkuchredux

actors :: fannkuchredux

Example implemented from "The computer Language Benchmarks Game" - Fannkuch-Redux

module fca

Formal Concept Analysis

module ffi

Full FFI support, independent of the compiler

module ffi_base

nitc :: ffi_base

Tools and utilities for implement FFI with different languages

module ffi_support

java :: ffi_support

Core supporting services for the FFI with Java

module file

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

module file_server

nitcorn :: file_server

Provides the FileServer action, which is a standard and minimal file server

module filter_stream

filter_stream :: filter_stream

module flat

Simple API for 2D games, built around Sprite and App::update

module flat_core

gamnit :: flat_core

Core services for the flat API for 2D games

module flow

Intraprocedural static flow.

module font

Abstract font drawing services, implemented by bmfont and tileset

module for_abuse

for_abuse :: for_abuse

Service management through the for control structure.

module foundation

cocoa :: foundation

The Foundation Kit provides basic Objective-C classes and structures

module frontend

nitc :: frontend

Collect and orchestration of main frontend phases

module functional

functional :: functional

Functional types and functional API for Iterator

module functional_gen

functional :: functional_gen

This module is only used to generate functional_types.nit

module functional_types

functional :: functional_types

This module provides functional type to represents various function forms.

module game

android :: game

Android services and implementation of app.nit for gamnit and mnit

module gamepad

android :: gamepad

Support for gamepad events (over Bluetooth or USB)

module gamnit

gamnit :: gamnit

Game and multimedia framework for Nit

module gamnit_android

gamnit :: gamnit_android

Support services for Gamnit on Android

module gamnit_ios

gamnit :: gamnit_ios

Support services for gamnit on iOS

module gamnit_linux

gamnit :: gamnit_linux

Support services for Gamnit on GNU/Linux

module gdk

Services from GDK

module gdk_enums

gtk :: gdk_enums

module gen_nit

gen_nit :: gen_nit

Support to generate and otherwise manipulate Nit code

module generate_hierarchies

nitc :: generate_hierarchies

Create dot files for various hierarchies of a model.

module geometry

geometry :: geometry

Provides interfaces and classes to represent basic geometry needs.

module gettext

gettext :: gettext

Internationalization of Strings using gettext library

module github

github :: github

Nit wrapper for Github API

module glesv2

glesv2 :: glesv2

OpenGL graphics rendering library for embedded systems, version 2.0

module glkit

GLKit services to create an OpenGL ES context on iOS

module global_compiler

nitc :: global_compiler

Global compilation of a Nit program

module glsl_validation

nitc :: glsl_validation

Check shader code within Nit modules using the tool glslangValidator

module gmp

Multi precision integer and rational number using gmp lib

module graph

Provides an interface for services on a Neo4j graphs.

module gtk

GTK+ widgets and services

module gtk_assistant

gtk :: gtk_assistant

module gtk_core

gtk :: gtk_core

Classes and services to use libGTK widgets

module gtk_dialogs

gtk :: gtk_dialogs

module gtk_enums

gtk :: gtk_enums

module gtk_widgets_ext

gtk :: gtk_widgets_ext

module hash_debug

hash_debug :: hash_debug

Inject behavior analysis to hash-collections (HashMap, HashSet, etc.)

module header_dependency

nitc :: header_dependency

Tracks which modules has public header code that must be imported

module hello

Example from http://www.graphviz.org/content/hello

module hello_cocoa

cocoa :: hello_cocoa

Hello world using the Cocoa framework

module hello_ios

ios :: hello_ios

Simple iOS app with a single label

module helpers

Contains "helper" classes, including support for bootstrapping SAX-based applications.

module highlight

nitc :: highlight

Highlighting of Nit AST

module hooks

github :: hooks

Github hook event listening with nitcorn.

module htcpcp_server

nitcorn :: htcpcp_server

A server that implements HTCPCP. At the moment there are no additions.

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 html_page

html :: html_page

module htmlight

nitc :: htmlight

Highlighting of Nit AST with HTML

module http_errors

nitcorn :: http_errors

Offers ErrorTemplate to display error pages

module http_request

ios :: http_request

Implementation of app::http_request for iOS

module http_request

linux :: http_request

Implementation of app::http_request using GDK and Curl

module http_request

app :: http_request

HTTP request services: AsyncHttpRequest and Text::http_get

module http_request

nitcorn :: http_request

Provides the HttpRequest class and services to create it

module http_request

android :: http_request

Android implementation of app:http_request

module http_request_buffer

nitcorn :: http_request_buffer

Http request parsing for buffered inputs.

module http_request_example

app :: http_request_example

Example for the app::http_request main service AsyncHttpRequest

module http_response

nitcorn :: http_response

Provides the HttpResponse class and http_status_codes

module i18n_phase

nitc :: i18n_phase

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

module image

Services of the SDL_image 2.0 library

module inheritance_metrics

nitc :: inheritance_metrics

Collect metrics about inheritance usage

module ini

Read and write INI configuration files

module input

Defines abstract classes for user and general inputs to the application.

module input

bcm2835 :: input

module input_events

android :: input_events

Pointer and hardware key events

module input_ios

gamnit :: input_ios

Gamnit event support for iOS

module input_source

sax :: input_source

A single input source for an XML entity.

module inspect

serialization :: inspect

Refine Serializable::inspect to show more useful information

module intent

android :: intent

Services allowing to launch activities and start/stop services using

module intent_api10

android :: intent_api10

Services allowing to launch activities and start/stop services using

module intent_api11

android :: intent_api11

Refines intent module to add API 11 services

module intent_api12

android :: intent_api12

Refines intent module to add API 12 services

module intent_api14

android :: intent_api14

Refines intent module to add API 14 services

module intent_api15

android :: intent_api15

Refines intent module to add API 15 services

module intent_api16

android :: intent_api16

Refines intent module to add API 16 services

module intent_api17

android :: intent_api17

Refines intent module to add API 17 services

module intent_api18

android :: intent_api18

Refines intent module to add API 18 services

module intent_api19

android :: intent_api19

Refines intent module to add API 19 services

module interpreter

nitc :: interpreter

Interpretation of Nit programs

module io

Services from the java.io package

module ios

iOS platform support

module ios

Compile programs for the iOS platform

module iter_extras

functional :: iter_extras

This modules provides a new functional interface for Iterator.

module java

FFI support for the Java language

module java

Supporting services for the FFI with Java and to access Java libraries

module java_compiler

nitc :: java_compiler

Compile Nit code to Java code

module jointask_example

pthreads :: jointask_example

Simple example of joinable task using threadpool

module json

Read and write JSON formatted text using the standard serialization services

module json_commands

nitc :: json_commands

Translate command results to json

module json_graph_store

neo4j :: json_graph_store

Provides JSON as a mean to store graphs.

module json_model

nitc :: json_model

Make model entities Serializable.

module jvm

Java Virtual Machine invocation API and others services from the JNI C API

module key_event

android :: key_event

module keys

Simple service keeping track of which keys are currently pressed

module landscape

gamnit :: landscape

Lock the application in the landscape orientation

module landscape

android :: landscape

Lock the application in the landscape orientation

module langannot

gettext :: langannot

Sample module showing the use of the i18n annotation

module lexer

Lexer and its tokens.

module lexer

saxophonit :: lexer

SAXophoNit’s lexer

module lexer_work

nitc :: lexer_work

Internal algorithm and data structures for the Nit lexer

module lexical_handler

sax :: lexical_handler

SAX2 extension handler for lexical events.

module lexpr

Logical expression.

module libevent

libevent :: libevent

Low-level wrapper around the libevent library to manage events on file descriptors

module libevent_example

libevent :: libevent_example

Minimal usage example of libevent

module libevent_test

libevent :: libevent_test

module light

Light FFI support for the compiler

module light_c

nitc :: light_c

Support for nesting C code within a Nit program using its FFI

module light_ffi

nitc :: light_ffi

Light FFI support, independent of the compiler

module light_ffi_base

nitc :: light_ffi_base

Tools and utilities for implement FFI with different languages

module light_only

nitc :: light_only

Compiler support for the light FFI only, detects unsupported usage of callbacks

module limit_fps

gamnit :: limit_fps

Frame-rate control for applications

module linux

Implementation of app.nit for the Linux platform

module literal

nitc :: literal

Parsing of literal values in the abstract syntax tree.

module load_image

android :: load_image

Low-level services to load pixel data from the assets

module loader

Loading of Nit source files

module loader

github :: loader

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 log

Services inserting a timestamp in all prints and to log each requests

module log

Advanced Android logging services

module logger

logger :: logger

A simple logger for Nit

module logic

First-order logic data structure and algorithm.

module macro

template :: macro

String templating using macros.

module man

markdown :: man

Simple groff decorator restricted for manpages.

module mandelbrot

actors :: mandelbrot

Example implemented from "The computer Language Benchmarks Game" - Mandelbrot

module markdown

markdown :: markdown

Markdown parsing.

module markdown2

markdown2 :: markdown2

module markdown_ast

markdown2 :: markdown_ast

Markdown AST representation

module markdown_block_parsing

markdown2 :: markdown_block_parsing

Markdown blocks parsing

module markdown_github

markdown2 :: markdown_github

Markdown Github mode

module markdown_html_rendering

markdown2 :: markdown_html_rendering

HTML rendering of Markdown documents

module markdown_inline_parsing

markdown2 :: markdown_inline_parsing

Parser for inline markdown

module markdown_latex_rendering

markdown2 :: markdown_latex_rendering

LaTeX rendering of Markdown documents

module markdown_man_rendering

markdown2 :: markdown_man_rendering

Manpages rendering of Markdown documents

module markdown_md_rendering

markdown2 :: markdown_md_rendering

Markdown rendering of Markdown documents

module markdown_rendering

markdown2 :: markdown_rendering

Markdown document rendering

module markdown_wikilinks

markdown2 :: markdown_wikilinks

Markdown wikilinks processing

module matrix

matrix :: matrix

Services for matrices of Float values

module mclassdef_collect

nitc :: mclassdef_collect

module mclasses_metrics

nitc :: mclasses_metrics

Collect common metrics about mclasses

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 media_types

nitcorn :: media_types

Services to identify Internet media types (or MIME types, Content-types)

module memory_logger

nitc :: memory_logger

Extension to inject memory-tracing instrumentation in code generated by nitc.

module mendel_metrics

nitc :: mendel_metrics

The Mendel model helps to understand class hierarchies.

module meta

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

module method_analyze_metrics

nitc :: method_analyze_metrics

module metrics

nitc :: metrics

Various statistics about Nit models and programs

module metrics_base

nitc :: metrics_base

Helpers for various statistics tools.

module minimal

sdl2 :: minimal

An example to test and demonstrate the sdl2 lib with image and events

module mixer

SDL2 mixer with sample/sounds and music

module mixin

Loading and additional module refinements at link-time.

module mmodule

nitc :: mmodule

modules and module hierarchies in the metamodel

module mmodule_data

nitc :: mmodule_data

Define and retrieve data in modules

module mmodules_metrics

nitc :: mmodules_metrics

Collect common metrics about 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_contract

nitc :: model_contract

The abstract concept of a contract in the model

module model_dimensions

gamnit :: model_dimensions

Dimensions related services for Model and Mesh

module model_examples

nitc :: model_examples

Examples for Model entities

module model_ext

nitc :: model_ext

Extensions to the Nit model for foreign languages.

module model_filters

nitc :: model_filters

module model_hyperdoc

nitc :: model_hyperdoc

Dump of Nit model into hypertext human-readable format.

module model_index

nitc :: model_index

Search things from the Model

module model_parser_base

gamnit :: model_parser_base

Services to parse models from a text description

module model_visitor

nitc :: model_visitor

Simple visitor framework for Nit models.

module model_viz

nitc :: model_viz

Visualisation of Nit models

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 mongodb

mongodb :: mongodb

MongoDB Nit Driver.

module more_collections

more_collections :: more_collections

Highly specific, but useful, collections-related classes.

module more_lights

gamnit :: more_lights

More implementations of Light

module more_materials

gamnit :: more_materials

Various material implementations

module more_meshes

gamnit :: more_meshes

More simple geometric meshes

module more_models

gamnit :: more_models

Services to load models from the assets folder

module mpackage

nitc :: mpackage

Modelisation of a Nit package

module mpd

Music Player Daemon client library

module mpi

Implementation of the Message Passing Interface protocol by wrapping OpenMPI

module mpi_simple

mpi :: mpi_simple

module msgpack

msgpack :: msgpack

MessagePack, an efficient binary serialization format

module msgpack_to_json

msgpack :: msgpack_to_json

Convert MessagePack format to JSON

module mtl

Services to parse .mtl material files

module naive_interpreter

nitc :: naive_interpreter

Interpretation of a Nit program directly on the AST

module namespace_support

sax :: namespace_support

Encapsulates Namespace logic for use by applications using SAX, or internally by SAX drivers.

module native_app_glue

android :: native_app_glue

Wrapper of the Android native_app_glue framework to implement app.nit

module native_curl

curl :: native_curl

Binding of C libCurl which allow us to interact with network.

module native_gmp

gmp :: native_gmp

Low-level GMP features

module native_mongodb

mongodb :: native_mongodb

Native wrapper for the MongoDB C Driver

module native_notification

android :: native_notification

Native Java classes for notifications

module native_postgres

postgresql :: native_postgres

A native wrapper ove the postgres c api

module native_sqlite3

sqlite3 :: native_sqlite3

Low-level Sqlite3 features

module native_ui

android :: native_ui

Native services from the android.view and android.widget namespaces

module neo

Save and load a Model to/from a Neo4j graph.

module neo4j

Neo4j connector through its JSON REST API using curl.

module network

gamnit :: network

Easy client/server logic for games and simple distributed applications

module nit

A naive Nit interpreter

module nit_activity

android :: nit_activity

Core implementation of app.nit on Android using a custom Java entry point

module nitc

A Nit compiler

module nitcatalog

nitc :: nitcatalog

Basic catalog generator for Nit packages

module nitcc_runtime

nitcc_runtime :: nitcc_runtime

Runtime library required by parsers and lexers generated by nitcc

module nitcorn

nitcorn :: nitcorn

The nitcorn Web server framework creates server-side Web apps in Nit

module nitcorn_hello_world

nitcorn :: nitcorn_hello_world

Hello World Web server example

module nitcorn_reverse_proxy

nitcorn :: nitcorn_reverse_proxy

Minimal example using a ProxyAction

module nitdoc

Generator of static API documentation for the Nit language

module nith

A ligHt Nit compiler

module niti_runtime

niti_runtime :: niti_runtime

Runtime library to loop around the main program for each line in file-name arguments

module nitj

Compile Nit into Java code runnable on the Java Virtual Machine.

module nitlight

nitc :: nitlight

Tool that produces highlighting for Nit programs

module nitls

Simple tool to list Nit source files

module nitmd

markdown :: nitmd

A Markdown parser for Nit.

module nitmd

markdown2 :: nitmd

A Markdown parser for Nit.

module nitmetrics

nitc :: nitmetrics

A program that collects various metrics on nit programs and libraries

module nitni

Native interface related services (used underneath the FFI)

module nitni_base

nitc :: nitni_base

Native interface related services (used underneath the FFI)

module nitni_callbacks

nitc :: nitni_callbacks

nitni services related to callbacks (used underneath the FFI)

module nitni_utilities

nitc :: nitni_utilities

module nitpackage

nitc :: nitpackage

Helpful features about packages

module nitpick

nitc :: nitpick

A program that collect potential style and code issues

module nitpm

Nit package manager command line interface

module nitpm_shared

nitc :: nitpm_shared

Services related to the Nit package manager

module nitpretty

nitc :: nitpretty

module nitrestful

nitc :: nitrestful

Tool generating boilerplate code linking RESTful actions to Nit methods

module nitsaf

Nit Static Analysis Framework client example.

module nitserial

nitc :: nitserial

Serialization support compiler, a tool to support deserialization of live generic types

module nitsmell_toolcontext

nitc :: nitsmell_toolcontext

module nitsmells

nitc :: nitsmells

module nituml

UML generator in dot format.

module nitunit

nitc :: nitunit

Testing tool.

module nitvm

The Nit virtual machine launcher

module nitweb

Runs a webserver based on nitcorn that render things from model.

module nitx

nitx, a command tool that displays useful data about Nit code

module nlp

Natural Language Processor based on the StanfordNLP core.

module nlp_index

nlp :: nlp_index

Example showing how to use a NLPFileIndex.

module nlp_server

nlp :: nlp_server

module no_warning

nitc :: no_warning

Fill toolcontext information about blacklisting of warnings.

module noise

Noise generators PerlinNoise and InterpolatedNoise

module notification

android :: notification

Services to show notification in the Android status bar

module nullables_metrics

nitc :: nullables_metrics

Statistics about the usage of nullables

module obj

Services to parse .obj geometry files

module objc

FFI support for Objective-C

module on_demand_compiler

nitc :: on_demand_compiler

Compiles extern code within a module to a static library, as needed

module opengles2_hello_triangle

glesv2 :: opengles2_hello_triangle

Basic example of OpenGL ES 2.0 usage using SDL 2

module opts

Management of options on the command line

module ordered_tree

ordered_tree :: ordered_tree

Manipulation and presentation of ordered trees.

module pagerank

graph :: pagerank

Add PageRank computation for vertices in Digraph.

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

XML DOM-parsing facilities

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 particles

gamnit :: particles

Particle effects

module perfect_hashing

perfect_hashing :: perfect_hashing

Perfect hashing and perfect numbering

module performance_analysis

performance_analysis :: performance_analysis

Services to gather information on the performance of events by categories

module phase

Phases of the processing of nit programs

module pipeline

pipeline :: pipeline

Pipelined filters and operations on iterators.

module pkgconfig

nitc :: pkgconfig

Offers the PkgconfigPhase to use the external program "pkg-config" in order

module platform

nitc :: platform

Platform system, used to customize the behavior of the compiler.

module platform

android :: platform

Triggers compilation for the android platform

module platform

ios :: platform

Triggers compilation for the iOS platform

module points_and_lines

geometry :: points_and_lines

Interfaces and classes to represent basic geometry needs.

module polygon

geometry :: polygon

Convex Polygons manipulations

module pop_auth

popcorn :: pop_auth

Authentification handlers.

module pop_config

popcorn :: pop_config

Configuration file and options for Popcorn apps

module pop_handlers

popcorn :: pop_handlers

Route handlers.

module pop_json

popcorn :: pop_json

Introduce useful services for JSON REST API handlers.

module pop_logging

popcorn :: pop_logging

module pop_repos

popcorn :: pop_repos

Repositories for data management.

module pop_routes

popcorn :: pop_routes

Internal routes representation.

module pop_sessions

popcorn :: pop_sessions

Session handlers

module pop_tasks

popcorn :: pop_tasks

Popcorn threaded tasks

module pop_templates

popcorn :: pop_templates

Template rendering for popcorn

module pop_tests

popcorn :: pop_tests

Popcorn testing services

module pop_tracker

popcorn :: pop_tracker

module pop_validation

popcorn :: pop_validation

Quick and easy validation framework for Json inputs

module popcorn

popcorn :: popcorn

Application server abstraction on top of nitcorn.

module portrait

gamnit :: portrait

Lock the application in the portrait orientation

module portrait

android :: portrait

Config to set the portrait orientation

module poset

Pre order sets and partial order set (ie hierarchies)

module poset_metrics

nitc :: poset_metrics

Metrics about the various posets of the model of a Nit program

module posix

Services conforming to POSIX

module postgres

postgresql :: postgres

Services to manipulate a Postgres database

module pretty

Library used to pretty print Nit code.

module privileges

privileges :: privileges

Process privileges management utilities

module programs

gamnit :: programs

Services for graphical programs with shaders, attributes and uniforms

module progression

progression :: progression

Event-based interface to track the progression of an operation.

module projection

matrix :: projection

Services on Matrix to transform and project 3D coordinates

module prompt

prompt :: prompt

Basic services to display a prompt

module protocol

core :: protocol

module proxy

nitcorn :: proxy

Provides the ProxyAction action, which redirects requests to another interface

module pthreads

nitcorn :: pthreads

Activate the use of pthreads with nitcorn

module pthreads

pthreads :: pthreads

Main POSIX threads support and intro the classes Thread, Mutex and Barrier

module puzzle

The N-puzzle problem, modeled naively as a SearchProblem.

module quadtree

geometry :: quadtree

QuadTree API mostly used for 2 dimensional collision detection

module queens

Example of the famous eight-queens problem solved with the ai::backtrack module.

module queries

mongodb :: queries

Mongo queries framework

module rapid_type_analysis

nitc :: rapid_type_analysis

Rapid type analysis on the AST

module rbtree

trees :: rbtree

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

module reaching_defs

nitc :: reaching_defs

module reactor

nitcorn :: reactor

Core of the nitcorn project, provides HttpFactory and Action

module read

msgpack :: read

Low-level read MessagePack format from Reader streams

module reader_model

saxophonit :: reader_model

Reader’s model.

module readline

readline :: readline

GNU readline library wrapper

module readme_metrics

nitc :: readme_metrics

Collect common metrics about README files

module realtime

realtime :: realtime

Services to keep time of the wall clock time

module redef_collections

pthreads :: redef_collections

Redef some basic collections to be thread-safe

module refinement_metrics

nitc :: refinement_metrics

Collect metrics about refinement usage

module regex_phase

nitc :: regex_phase

Check for error in regular expressions from string literals

module repeating_key_xor_solve

crapto :: repeating_key_xor_solve

module restful

nitcorn :: restful

Support module for the nitrestful tool and the restful annotation

module restful_annot

nitcorn :: restful_annot

Example for the restful annotation documented at lib/nitcorn/restful.nit

module ropes_debug

ropes_debug :: ropes_debug

Exposes methods for debugging ropes when needed.

module rta_metrics

nitc :: rta_metrics

Metrics from RTA

module rubix

Rubix-cube modelization library

module saf

Nit Static Analysis Framework.

module saf_base

nitc :: saf_base

Static Analysis Framework base

module safe

serialization :: safe

Services for safer deserialization engines

module sax

Core SAX APIs.

module sax_locator

sax :: sax_locator

Interface for associating a SAX event with a document location.

module sax_locator_impl

sax :: sax_locator_impl

Provides an optional convenience implementation of Locator.

module sax_parse_exception

sax :: sax_parse_exception

Encapsulates an XML parse error or warning.

module saxophonit

saxophonit :: saxophonit

A SAX 2 parser in Nit.

module scene2d

scene2d :: scene2d

Framework for 2D management of game elements

module scope

Identification and scoping of local variables and labels.

module sdl2

Simple DirectMedia Layer (SDL) 2.0 services for easy window creation and 2D drawing

module sdl2_base

sdl2 :: sdl2_base

Basic SDL 2 features

module search

Basic framework for search problems and solver.

module selection

gamnit :: selection

Select Actor from a screen coordinate

module self_metrics

nitc :: self_metrics

Metrics about the usage of explicit and implicit self

module semantize

nitc :: semantize

Process bodies of methods in regard with the model.

module sendmail

sendmail :: sendmail

Send emails using the sendmail program

module sensors

android :: sensors

Access Android sensors

module separate_compiler

nitc :: separate_compiler

Separate compilation of a Nit program

module separate_erasure_compiler

nitc :: separate_erasure_compiler

Separate compilation of a Nit program with generic type erasure

module sequential_id

neo4j :: sequential_id

Provides a sequential identification scheme for Neo4j nodes.

module serialization

serialization :: serialization

General serialization services

module serialization_code_gen_phase

nitc :: serialization_code_gen_phase

Phase generating methods (code) to serialize Nit objects

module serialization_common

msgpack :: serialization_common

Serialization services for serialization_write and serialization_read

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

msgpack :: serialization_read

Deserialize full Nit objects from MessagePack format

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 serialization_write

msgpack :: serialization_write

Serialize full Nit objects to MessagePack format

module serialize_model

nitc :: serialize_model

Service to serialize POSet to JSON

module server

gamnit :: server

Server-side network services for games and such

module server_config

nitcorn :: server_config

Classes and services to configure the server

module service

android :: service

Android service support for app.nit centered around the class Service

module sessions

nitcorn :: sessions

Automated session management

module sexp

S-Expression parsing facilities

module sha1

Provides methods to compute the SHA1 hash of a String

module shadow

gamnit :: shadow

Shadow mapping using a depth texture

module shared_preferences

android :: shared_preferences

Services allowing to save and load datas to internal android device

module shared_preferences_api10

android :: shared_preferences_api10

Services to save/load data using android.content.SharedPreferences for the android platform

module shared_preferences_api11

android :: shared_preferences_api11

Refines shared_preferences module to add API 11 services

module show_basedir

xdg_basedir :: show_basedir

Prints the local base directories as per the XDG Base Directory specification

module signal_handler

nitcorn :: signal_handler

Handle SIGINT and SIGTERM to close the server after all active events

module signals

signals :: signals

ANSI C signal handling

module simple

actors :: simple

A very simple example of the actor model

module simple_file_server

nitcorn :: simple_file_server

Basic file server on port 80 by default, may require root to execute

module simple_misc_analysis

nitc :: simple_misc_analysis

Simple vavious processing on a AST

module simple_simulation

actors :: simple_simulation

Using agent_simulation by refining the Agent class to make

module socket

socket :: socket

Socket services

module socket_c

socket :: socket_c

Low-level socket functionalities

module socket_client

socket :: socket_client

Client sample using the Socket module which connect to the server sample.

module socket_server

socket :: socket_server

Server sample using the Socket module which allow client to connect

module socket_simple_server

socket :: socket_simple_server

Simple server example using a non-blocking TCPServer

module sqlite3

sqlite3 :: sqlite3

Services to manipulate a Sqlite3 database

module ssa

Single-Static Assignment algorithm from an AST

module standard

standard :: standard

Old module implicitly imported by the old compiler.

module stanford

nlp :: stanford

Natural Language Processor based on the StanfordNLP core.

module static

Nitdoc generation framework

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_html

nitc :: static_html

Render documentation pages as HTML

module static_index

nitc :: static_index

Manage indexing of Nit model for Nitdoc QuickSearch.

module static_structure

nitc :: static_structure

Composes the pages of the static documentation

module static_types_metrics

nitc :: static_types_metrics

Metrics on the usage of explicit static types.

module stereoscopic_view

gamnit :: stereoscopic_view

Refine EulerCamera and App::frame_core_draw to get a stereoscopic view

module store

Store and load json data.

module stream

Input and output streams of characters

module symbol

symbol :: symbol

Library for simple interning of strings

module syswm

Window manager related SDL 2 services

module tables

Module that interfaces the parsing tables.

module tables_metrics

nitc :: tables_metrics

Metrics on table generation

module template

template :: template

Basic template system

module term

module term_model

nitc :: term_model

Markdown templates for Nit model MEntities.

module test_astbuilder

nitc :: test_astbuilder

Program used to test the clone method of the astbuilder tool

module test_highlight

nitc :: test_highlight

Program used to test the Nit highlighter

module test_markdown

markdown2 :: test_markdown

Test suites for module markdown

module test_model_index

nitc :: test_model_index

module test_model_visitor

nitc :: test_model_visitor

Example of model_visitor

module test_neo

nitc :: test_neo

Test for neo model saving and loading.

module test_parser

nitc :: test_parser

Program used to test the NIT parser

module test_phase

nitc :: test_phase

Stub for loading a runing phases on a bunch of modules

module test_restful_annot

nitcorn :: test_restful_annot

module test_test_phase

nitc :: test_test_phase

Example of simple module that aims to do some specific work on nit programs.

module test_toolcontext

nitc :: test_toolcontext

Program used to test ToolContext

module test_utils

functional :: test_utils

module testing

nitc :: testing

Test unit generation and execution for Nit.

module testing

saxophonit :: testing

Various utilities to help testing SAXophoNit (and SAX parsers in general).

module testing_base

nitc :: testing_base

Base options for testing tools.

module testing_doc

nitc :: testing_doc

Testing from code comments.

module testing_gen

nitc :: testing_gen

Test Suites generation.

module testing_suite

nitc :: testing_suite

Testing from external files.

module text_stat

text_stat :: text_stat

Injects stat-calculating functionalities to Text and its variants

module texture_atlas_parser

gamnit :: texture_atlas_parser

Tool to parse XML texture atlas and generated Nit code to access subtextures

module textures

gamnit :: textures

Load textures, create subtextures and manage their life-cycle

module thread_ring

actors :: thread_ring

Example implemented from "The computer Language Benchmarks Game" - Thread-Ring

module threaded_example

pthreads :: threaded_example

test for threaded annotation

module threadpool

pthreads :: threadpool

Introduces a minimal ThreadPool implementation using Tasks

module threadpool_example

pthreads :: threadpool_example

Simple example using threadpool

module tileset

gamnit :: tileset

Support for TileSet, TileSetFont and drawing text with TextSprites

module time

Management of time and dates

module tmpl_composer

template :: tmpl_composer

module toast

android :: toast

Services to display a toast, a small popup on Android

module token

nitcorn :: token

Simple generate_token service, independent of the rest of the nitcorn framework

module toolcontext

nitc :: toolcontext

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

module transform

nitc :: transform

Thansformations that simplify the AST of expressions

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 u16_string

core :: u16_string

Wrapper of ICU's UTF-16 encoded strings and conversion

module ui

Implementation of the app.nit UI module for GNU/Linux

module ui

Implementation of app::ui for iOS

module ui

Views and services to use the Android native user interface

module ui

Portable UI controls for mobiles apps

module ui_example

app :: ui_example

User interface example using app::ui

module ui_test

android :: ui_test

Test for app.nit's UI services

module uikit

File generated by objcwrapper

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 undirected_clusters

dot :: undirected_clusters

Example from http://www.graphviz.org/Gallery/undirected/fdpclust.html

module v3_10

GTK+ services added at version 3.10

module v3_4

module v3_6

GTK+ services added at version 3.6

module v3_8

GTK+ services added at version 3.8

module vararg_routes

nitcorn :: vararg_routes

Routes with parameters.

module variables_numbering

nitc :: variables_numbering

Handle all numbering operations related to local variables in the Nit virtual machine

module version

nitc :: version

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

module vibration

android :: vibration

Vibration services for Android

module vim_autocomplete

nitc :: vim_autocomplete

Generate files used by the Vim plugin to autocomplete with doc

module virtual_gamepad

gamnit :: virtual_gamepad

Virtual gamepad mapped to keyboard keys for quick and dirty mobile support

module virtual_gamepad_spritesheet

gamnit :: virtual_gamepad_spritesheet

module virtual_machine

nitc :: virtual_machine

Implementation of the Nit virtual machine

module vm

Entry point of all vm components

module vm_optimizations

nitc :: vm_optimizations

Optimization of the nitvm

module vr

VR support for gamnit depth, for Android only

module vsm

Vector Space Model

module wallet

github :: wallet

Github OAuth tokens management

module websocket

websocket :: websocket

Adds support for a websocket connection in Nit

module websocket_server

websocket :: websocket_server

Sample module for a minimal chat server using Websockets on port 8088

module wifi

android :: wifi

Simple wrapper of the Android WiFi services

module wikilinks

markdown :: wikilinks

Wikilinks handling.

module write

msgpack :: write

Low-level write in MessagePack format to Writer streams

module x11

Services from the X11 library

module xcode_templates

nitc :: xcode_templates

Templates and other services to create XCode projects

module xdg_basedir

xdg_basedir :: xdg_basedir

Services for using the XDG Base Directory specification

module xml_entities

dom :: xml_entities

Basic blocks for DOM-XML representation

module xml_filter

sax :: xml_filter

Interface for an XML filter.

module xml_filter_impl

sax :: xml_filter_impl

Base class for deriving an XML filter.

module xml_reader

sax :: xml_reader

Interface for reading an XML document using callbacks.

module xor

Cryptographic attacks and utilities for XOR-based algorithms.

module xor_ciphers

crypto :: xor_ciphers

XOR oriented cryptographic ciphers and utilities.

# Base for codecs to use with streams
#
# A Codec (Coder/Decoder) is a tranformer from a byte-format to another
#
# As Nit Strings are UTF-8, a codec works as :
# - Coder: From a UTF-8 string to a specified format (writing)
# - Decoder: From a specified format to a UTF-8 string (reading)
module codec_base

import text
import bytes

# Codes/Decodes entities from/to UTF-8
abstract class Codec
	# Maximum size of a `character` in supported encoding
	fun char_max_size: Int is abstract

	# Transforms `c` to its representation in the format of `self`
	fun encode_char(c: Char): CString is abstract

	# Adds a char `c` to bytes `s`
	#
	# Returns the number of bytes written to `s`
	fun add_char_to(c: Char, s: CString): Int is abstract

	# Transforms `s` to the format of `self`
	fun encode_string(s: Text): Bytes is abstract

	# Adds a string `s` coded as the supported encoding to `b`
	#
	# Returns the number of bytes written to `s`
	fun add_string_to(s: Text, b: Bytes): Int is abstract

	# Size of a codet for the target encoding
	fun codet_size: Int is abstract

	# How many lookaheads might be required to decode a single char ?
	fun max_lookahead: Int is abstract

	# Is the sequence of bytes in `ns` at `position` a valid Char ?
	#
	# Returns either
	# * 0 if valid
	# * 1 if incomplete
	# * 2 if invalid
	fun is_valid_char(ns: CString, position: Int): Int is abstract

	# Decodes a char from `b` to a Unicode code-point
	fun decode_char(b: CString): Char is abstract

	# Decodes a string `b` to UTF-8
	fun decode_string(b: CString, len: Int): String is abstract
end

lib/core/codecs/codec_base.nit:15,1--67,3