package frama-c

You can search for identifiers within the package.

in-package search v0.2.0

Platform dedicated to the analysis of source code written in C

Install

Dune Dependency

frama-c.com Readme Edit opam file Versions (25)

Authors

Maintainers

F

frama-ci-bot@frama-c.com

Sources

frama-c-31.0-Gallium.tar.gz

sha256=a94384f00d53791cbb4b4d83ab41607bc71962d42461f02d71116c4ff6dca567

doc/frama-c-server.core/Server/Package/index.html

Module `Server.Package`Source

Sourcetype plugin =

| Kernel
| Plugin of string

Sourcetype ident = private {

plugin : plugin;
package : string list;
name : string;

}

Sourcetype jtype =

| Jany
| Jnull
| Jboolean
| Jnumber
| Jstring
| Jalpha
(*
string primarily compared without case
*)
| Jtag of string
(*
single constant string
*)
| Jkey of string
(*
kind of a string used for indexing
*)
| Jindex of string
(*
kind of an integer used for indexing
*)
| Joption of jtype
| Jdict of jtype
(*
dictionaries
*)
| Jarray of jtype
(*
order matters
*)
| Jtuple of jtype list
| Junion of jtype list
| Jrecord of (string * jtype) list
| Jenum of ident * string list
(*
type and tags
*)
| Jdata of ident * jtype
(*
type and definition
*)
| Jself
(*
for (simply) recursive types
*)

Sourcetype fieldInfo = {

fd_name : string;
fd_type : jtype;
fd_descr : Frama_c_kernel.Markdown.text;

}

Sourcetype tagInfo = {

tg_name : string;
tg_label : Frama_c_kernel.Markdown.text;
tg_descr : Frama_c_kernel.Markdown.text;

}

Sourcetype paramInfo =

| P_value of jtype
| P_named of fieldInfo list

Sourcetype requestInfo = {

rq_kind : [ `GET | `SET | `EXEC ];
rq_input : paramInfo;
rq_output : paramInfo;
rq_signals : string list;

}

Sourcetype arrayInfo = {

arr_key : string;
arr_kind : jtype;
arr_rows : jtype;

}

Sourcetype declKindInfo =

| D_signal
| D_type of jtype
| D_enum of tagInfo list
| D_record of fieldInfo list
| D_request of requestInfo
| D_value of jtype
| D_state of jtype
| D_array of arrayInfo
| D_decoder of ident * jtype
| D_order of ident * jtype
| D_default of ident * jtype

Sourcetype declInfo = {

d_ident : ident;
d_descr : Frama_c_kernel.Markdown.text;
d_kind : declKindInfo;

}

Sourcetype packageInfo = {

p_plugin : plugin;
p_package : string list;
p_title : string;
p_descr : Frama_c_kernel.Markdown.text;
p_readme : string option;
p_content : declInfo list;

}

Sourceval pp_plugin : Stdlib.Format.formatter -> plugin -> unit

Sourceval pp_pkgname : Stdlib.Format.formatter -> packageInfo -> unit

Sourceval pp_ident : Stdlib.Format.formatter -> ident -> unit

Sourceval pp_jtype : Stdlib.Format.formatter -> jtype -> unit

Sourceval derived : ?prefix:string -> ?suffix:string -> ident -> ident

Sourcemodule Derived : sig ... end

module IdMap : Stdlib.Map.S with type key = ident

Sourcemodule Scope : sig ... end

Sourceval isRecursive : jtype -> bool

Sourceval visit_jtype : (ident -> unit) -> jtype -> unit

Sourceval visit_field : (ident -> unit) -> fieldInfo -> unit

Sourceval visit_param : (ident -> unit) -> paramInfo -> unit

Sourceval visit_request : (ident -> unit) -> requestInfo -> unit

Sourceval visit_dkind : (ident -> unit) -> declKindInfo -> unit

Sourceval visit_decl : (ident -> unit) -> declInfo -> unit

Sourceval visit_package_decl : (ident -> unit) -> packageInfo -> unit

Sourceval visit_package_used : (ident -> unit) -> packageInfo -> unit

Sourcetype package

Source

val package : 
  ?plugin:string ->
  ?name:string ->
  title:string ->
  ?descr:Frama_c_kernel.Markdown.text ->
  ?readme:string ->
  unit ->
  package

Source

val declare : 
  package:package ->
  name:string ->
  ?descr:Frama_c_kernel.Markdown.text ->
  declKindInfo ->
  unit

Register the declaration in the Server API. This is only way to obtain identifiers. This ensures identifiers are declared before being used.

Source

val declare_id : 
  package:package ->
  name:string ->
  ?descr:Frama_c_kernel.Markdown.text ->
  declKindInfo ->
  ident

Same as declare but returns the associated identifier.

Sourceval update : package:package -> name:string -> declKindInfo -> unit

Replace the declaration for the given name in the package.

Sourceval iter : (packageInfo -> unit) -> unit

Sourceval resolve : ?keywords:string list -> packageInfo -> string IdMap.t

Assigns non-classing names for each identifier.

Sourceval field : fieldInfo -> string * jtype

Sourceval name_of_pkg : ?sep:string -> plugin -> string list -> string

Sourceval name_of_pkginfo : ?sep:string -> packageInfo -> string

Sourceval name_of_package : ?sep:string -> package -> string

Sourceval name_of_ident : ?sep:string -> ident -> string

Sourcetype pp = {

self : Frama_c_kernel.Markdown.text;
ident : ident -> Frama_c_kernel.Markdown.text;

}

Sourceval litteral : string -> Frama_c_kernel.Markdown.text

Quoted string

Sourceval md_jtype : pp -> jtype -> Frama_c_kernel.Markdown.text

Sourceval md_tags : ?title:string -> tagInfo list -> Frama_c_kernel.Markdown.table

Source

val md_fields : 
  ?title:string ->
  pp ->
  fieldInfo list ->
  Frama_c_kernel.Markdown.table

package frama-c

Install

Dune Dependency

Authors

Maintainers

Sources

doc/frama-c-server.core/Server/Package/index.html

Module Server.PackageSource

Module `Server.Package`Source