*)
let chop dir f =
let n = Str.search_forward (Str.regexp dir) f 0 in
let f = String.sub f n (String.length f - n) in
let d = Filename.dirname f in
String.capitalize (Filename.basename d)
in
try
Chapter(1,"Kernel Services","src/kernel_services"),
chop "kernel_services/" f
with Not_found ->
try Chapter(2,"Libraries","src/libraries"), chop "libraries/" f
with Not_found ->
try
Chapter(3,"Kernel Internals","src/kernel_internals"),
chop "kernel_internals/" f
with Not_found ->
let d = Filename.dirname f in
Directory (Filename.basename (Filename.dirname d)) ,
String.capitalize (Filename.basename d)
in
let structured_modules (* chapter, section, module *) =
(List.map
(fun name ->
let m = List.find (fun m -> m.m_name = name) self#list_modules in
let dir,name = dir m.m_file in
dir,name,m)
l)
in
let toc_modules (* chapter/section/modules *) =
merge3 compare_chapter compare compare structured_modules
in
List.iter
(fun (chapter, subdirs) ->
let dir =
( match chapter with
| Chapter (n,a,d) ->
bp b "Chapter %d. %s
" n a ; d
| Directory d ->
bp b "Directory %s
" d ; d)
in
List.iter
(fun (subdir,modules) ->
bp b "Section %s (in %s/%s)
\n"
subdir dir (String.lowercase subdir) ;
bs b "
\n\n";
List.iter
(fun m ->
bs b "| ";
(try
let (html, _) = Naming.html_files m.m_name in
bp b "%s | " html m.m_name;
bs b "";
self#html_of_info_first_sentence b m.m_info;
with Not_found ->
Odoc_messages.pwarning
(Odoc_messages.cross_module_not_found m.m_name);
bp b "%s | " m.m_name);
bs b " |
\n")
modules;
bs b "
\n")
subdirs)
toc_modules
(** Print html code for an included module. *)
method html_of_included_module b im =
bs b "";
bs b ((self#keyword "include")^" ");
(
match im.im_module with
None ->
bs b im.im_name
| Some mmt ->
let (file, name) =
match mmt with
Mod m ->
let (html_file, _) = Naming.html_files m.m_name in
(html_file, m.m_name)
| Modtype mt ->
let (html_file, _) =
Naming.html_files mt.mt_name
in
(html_file, mt.mt_name)
in
bp b "%s" (self#path name) file name
);
bs b "\n";
self#html_of_info b im.im_info
(** Generate all the html files from a module list. The main
file is [.html]. *)
method generate module_list =
(* init the style *)
self#init_style ;
(* init the lists of elements *)
list_values <- Odoc_info.Search.values module_list ;
list_exceptions <- Odoc_info.Search.exceptions module_list ;
list_types <- Odoc_info.Search.types module_list ;
list_attributes <- Odoc_info.Search.attributes module_list ;
list_methods <- Odoc_info.Search.methods module_list ;
list_classes <- Odoc_info.Search.classes module_list ;
list_class_types <- Odoc_info.Search.class_types module_list ;
list_modules <- Odoc_info.Search.modules module_list ;
list_module_types <- Odoc_info.Search.module_types module_list ;
(* prepare the page header *)
self#prepare_header module_list ;
(* Get the names of all known types. *)
let types = Odoc_info.Search.types module_list in
known_types_names <-
List.fold_left
(fun acc t -> StringSet.add t.Odoc_type.ty_name acc)
known_types_names
types ;
(* Get the names of all class and class types. *)
let classes = Odoc_info.Search.classes module_list in
let class_types = Odoc_info.Search.class_types module_list in
known_classes_names <-
List.fold_left
(fun acc c -> StringSet.add c.Odoc_class.cl_name acc)
known_classes_names
classes ;
known_classes_names <-
List.fold_left
(fun acc ct -> StringSet.add ct.Odoc_class.clt_name acc)
known_classes_names
class_types ;
(* Get the names of all known modules and module types. *)
let module_types = Odoc_info.Search.module_types module_list in
let modules = Odoc_info.Search.modules module_list in
known_modules_names <-
List.fold_left
(fun acc m -> StringSet.add m.m_name acc)
known_modules_names
modules ;
known_modules_names <-
List.fold_left
(fun acc mt -> StringSet.add mt.mt_name acc)
known_modules_names
module_types ;
(* generate html for each module *)
let keep_list =
let keep m =
not (List.exists (equal_module m) self#loaded_modules) &&
not (List.exists (equal_module_name m) !lib_files)
in
List.filter keep module_list
in
if not !Odoc_args.index_only then
self#generate_elements self#generate_for_module keep_list ;
(* reinit the lists of elements *)
list_values <- Odoc_info.Search.values keep_list ;
list_exceptions <- Odoc_info.Search.exceptions keep_list ;
list_types <- Odoc_info.Search.types keep_list ;
list_attributes <- Odoc_info.Search.attributes keep_list ;
list_methods <- Odoc_info.Search.methods keep_list ;
list_classes <- Odoc_info.Search.classes keep_list ;
list_class_types <- Odoc_info.Search.class_types keep_list ;
list_modules <- Odoc_info.Search.modules keep_list ;
list_module_types <- Odoc_info.Search.module_types keep_list ;
try
self#generate_index keep_list;
self#generate_values_index keep_list ;
self#generate_exceptions_index keep_list ;
self#generate_types_index keep_list ;
self#generate_attributes_index keep_list ;
self#generate_methods_index keep_list ;
self#generate_classes_index keep_list ;
self#generate_class_types_index keep_list ;
self#generate_modules_index keep_list ;
self#generate_module_types_index keep_list ;
with Failure s ->
prerr_endline s ;
incr Odoc_info.errors
method private html_of_plugin_developer_guide _t =
"Consult the Plugin Development Guide for additional details.
\n"
method private html_of_ignore _t = ""
method private html_of_modify t = match t with
| [] ->
Odoc_info.warning "Found an empty @modify tag";
""
| Raw s :: l ->
let time, explanation =
try
let idx = String.index s ' ' in
String.sub s 0 idx,
":" ^ String.sub s idx (String.length s - idx)
with Not_found ->
s, ""
in
let text =
Bold [ Raw "Change in "; Raw time ] :: Raw explanation :: l
in
let buf = Buffer.create 7 in
self#html_of_text buf text;
Buffer.add_string buf "
\n";
Buffer.contents buf
| _ :: _ ->
assert false
method private html_of_call t = match t with
| [] ->
Odoc_info.warning "Found an empty @call tag";
""
| l ->
let buf = Buffer.create 97 in
Buffer.add_string buf "Access it by ";
self#html_of_text buf l;
Buffer.add_string buf "\n";
Buffer.contents buf
(* Write the subtitle (eg. "Frama-C Kernel" after the main title
instead of before, for users that use many tabs in their browser *)
method inner_title s =
match self#title with "" -> "" | t -> self#escape s ^ " - " ^ t
initializer
tag_functions <-
("modify", self#html_of_modify) ::
("ignore", self#html_of_ignore) ::
("call", self#html_of_call) ::
("plugin", self#html_of_plugin_developer_guide) :: tag_functions
end
let () =
Odoc_args.set_doc_generator (Some (new gen :> Odoc_args.doc_generator));
Odoc_args.add_option
("-docpath", Arg.Set_string doc_path, "Frama-C documentation directory");
Odoc_args.add_option
("-stdlib", Arg.String (add_libfiles true), "Standard library files");
Odoc_args.add_option
("-stdlib-path", Arg.String (add_libfiles false), "Standard library files")
frama-c-Magnesium-20151002/doc/code/style.css 0000644 0001750 0001750 00000012562 12645746441 017511 0 ustar mehdi mehdi /**************************************************************************/
/* */
/* This file is part of Frama-C. */
/* */
/* Copyright (C) 2007-2015 */
/* CEA (Commissariat à l'énergie atomique et aux énergies */
/* alternatives) */
/* */
/* you can redistribute it and/or modify it under the terms of the GNU */
/* Lesser General Public License as published by the Free Software */
/* Foundation, version 2.1. */
/* */
/* It is distributed in the hope that it will be useful, */
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
/* GNU Lesser General Public License for more details. */
/* */
/* See the GNU Lesser General Public License version 2.1 */
/* for more details (enclosed in the file licenses/LGPLv2.1). */
/* */
/**************************************************************************/
* { margin: 0; padding: 0 }
body {
color: #222;
font-family: "Verdana", sans;
font-size: 11px;
width: 18cm;
margin-left: 2.5cm;
margin-top: 0.5cm;
margin-bottom: 1cm;
padding: 4mm 18mm 4mm 28mm;
background: #ffffff url(frama-c.png) no-repeat fixed 5mm 1cm ;
}
h1 {
width: 18cm;
font-family: "Optima", "Verdana", "Arial", sans;
text-align: left;
margin-top: 5mm;
margin-bottom: 2mm;
padding-left: 3mm;
border-left: 20px solid darkorange;
}
h2 {
width: 18cm;
font-family: "Optima", "Verdana", "Arial", sans;
margin-top: 5mm;
margin-bottom: 2mm;
padding-left: 3mm;
border-bottom: thin solid #404040;
}
h1.chapter {
clear: both;
text-align: left;
font-family: "Optima", "Verdana", "Arial", sans;
font-size: 2.0em;
font-weight: normal;
color: black;
margin: 0.4em 0em 0.4em 0em;
padding: 0.4em 0em 0em 0em;
border-left: none;
border-bottom: thin solid #404040;
}
h2.section {
width: 18cm;
font-family: "Optima", "Verdana", "Arial", sans;
margin-top: 5mm;
margin-bottom: 2mm;
padding-left: 3mm;
border-bottom: none;
border-left: 20px solid darkorange;
color: darkred;
}
h2.section .directory {
font-size: smaller ;
color: #707070 ;
font-familly: "Everson Mono", monospace ;
}
h3 {
width: 18cm;
font-family: "Optima", "Verdana", "Arial", sans;
color: black;
margin-top: 5mm;
margin-bottom: 3mm;
border-bottom: thin solid #404040;
}
h4,h5,h6, div.h7, div.h8, div.h9 {
margin-left: 4mm;
margin-top: 4mm;
margin-bottom: 1mm;
font-family: "Optima", "Verdana", "Arial", sans;
font-size: 10px;
font-style: italic;
font-weight: bold;
color: darkred;
}
p,ul { margin: 2mm; width: 15cm; margin-left: 0mm; }
hr { border: none ; border-top: 1px solid #404040; margin-top: 4mm; margin-bottom: 4mm }
a:visited { color: darkblue; text-decoration: none }
a:link { color: darkblue; text-decoration: none }
a:hover { background-color: lightgray; color: firebrick }
a:active { background-color: lightgray; color: darkgreen }
.navbar {
margin-left: 1cm ;
margin-bottom: 4mm ;
font-size: 9px ;
}
.navbar a:link { color: darkgreen; }
.navbar a:visited { color: darkgreen; }
.keyword { font-weight : bold; color: darkgoldenrod }
.keywordsign { color : #C04600 }
.superscript { font-size: 7px }
.subscript { font-size: 7px }
.warning { color: firebrick ; font-style: italic; margin-right:1ex }
.info {
padding: 1mm 1mm 1mm 1em;
margin-top: 0mm;
margin-bottom: 2mm;
margin-left: 1em;
margin-right: 3em;
border-left: thin dotted darkgreen;
}
table .info { border: none }
.param_info { margin-top: 4px; margin-left : 3em; margin-right : 3em }
.typetable { border-style : hidden }
.indextable {
margin-left: 3mm;
margin-top: 2mm ;
padding: 2mm 6mm 2mm 4mm ;
border-style : hidden ;
border-left: darkgreen thin solid ;
}
.paramstable { border-style : hidden ; padding: 5pt 5pt }
tr { font-size: 11px }
td { padding:0 ; margin:2px 5px 2px 10px ; vertical-align: top }
td .info { padding:0 ; margin-top:0 ; margin-bottom:0 ; border-left: none ; vertical-align: top }
td.typefieldcomment { font-family: serif; color: darkgreen }
pre { color : #263F71 ; font-size: 11px; font-family: "Everson Mono", monospace; margin-top: 1mm }
.code { color : #465F91 ; font-size: 11px; font-family: "Everson Mono", monospace }
.comment { color : darkgreen; font-family: serif }
.constructor { color : darkblue }
.type { color: #5C6585 }
.string { color: maroon }
div.sig_block {margin-left: 2em}
li { margin-left: 2em }
.copyright { margin-top: 5mm; font-size:10px; padding-top: 2mm; border-top: thin solid #404040; }
.copyright a:visited { color:darkred }
.copyright a:link { color:darkred } frama-c-Magnesium-20151002/doc/code/intro_wp.txt 0000644 0001750 0001750 00000003455 12645746441 020242 0 ustar mehdi mehdi @ignore
@ignore
@ignore This file is part of WP plug-in of Frama-C.
@ignore
@ignore Copyright (C) 2007-2015
@ignore CEA (Commissariat a l'energie atomique et aux energies
@ignore alternatives)
@ignore
@ignore you can redistribute it and/or modify it under the terms of the GNU
@ignore Lesser General Public License as published by the Free Software
@ignore Foundation, version 2.1.
@ignore
@ignore It is distributed in the hope that it will be useful,
@ignore but WITHOUT ANY WARRANTY; without even the implied warranty of
@ignore MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
@ignore GNU Lesser General Public License for more details.
@ignore
@ignore See the GNU Lesser General Public License version 2.1
@ignore for more details (enclosed in the file licenses/LGPLv2.1).
@ignore
@ignore
{2 Overview}
The WP plugin is dedicated to compute Weakest-Preconditions using
different memory models.
It is experimental and still under development.
frama-c-Magnesium-20151002/doc/code/intro_kernel_plugin.txt 0000644 0001750 0001750 00000004145 12645746441 022447 0 ustar mehdi mehdi @ignore
@ignore
@ignore This file is part of Frama-C.
@ignore
@ignore Copyright (C) 2007-2015
@ignore CEA (Commissariat à l'énergie atomique et aux énergies
@ignore alternatives)
@ignore
@ignore you can redistribute it and/or modify it under the terms of the GNU
@ignore Lesser General Public License as published by the Free Software
@ignore Foundation, version 2.1.
@ignore
@ignore It is distributed in the hope that it will be useful,
@ignore but WITHOUT ANY WARRANTY; without even the implied warranty of
@ignore MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
@ignore GNU Lesser General Public License for more details.
@ignore
@ignore See the GNU Lesser General Public License version 2.1
@ignore for more details (enclosed in the file licenses/LGPLv2.1).
@ignore
@ignore
{2 API Documentation}
The _PluginName_ plugin is integrated with the Frama-C kernel:
- {{:../index.html}Frama-C} complete kernel API
- {{:../html/Db._PluginName_.html}_PluginName_} available kernel API
{2 Internal Documentation}
- {{:modules.svg}_PluginName_} architecture (SVG format)
- Index of {{:index_modules.html}Modules}
- Index of {{:index_types.html}Types}
- Index of {{:index_values.html}Values}
- Index of {{:index_exceptions.html}Exceptions}
frama-c-Magnesium-20151002/doc/code/intro_scope.txt 0000644 0001750 0001750 00000004115 12645746441 020717 0 ustar mehdi mehdi @ignore
@ignore
@ignore This file is part of Frama-C.
@ignore
@ignore Copyright (C) 2007-2015
@ignore CEA (Commissariat à l'énergie atomique et aux énergies
@ignore alternatives)
@ignore
@ignore you can redistribute it and/or modify it under the terms of the GNU
@ignore Lesser General Public License as published by the Free Software
@ignore Foundation, version 2.1.
@ignore
@ignore It is distributed in the hope that it will be useful,
@ignore but WITHOUT ANY WARRANTY; without even the implied warranty of
@ignore MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
@ignore GNU Lesser General Public License for more details.
@ignore
@ignore See the GNU Lesser General Public License version 2.1
@ignore for more details (enclosed in the file licenses/LGPLv2.1).
@ignore
@ignore
{2 Overview}
See how to use the plugin in the
{{:../../www/src/scope.html}user documentation}.
(see also {{:../../scope/scope.txt}there} for a discussion on how we arrived to
those definitions)
{2 Inside the plugin}
The code of this plugin is quite simple. It is only composed of :
- {!module:Datascope_gui} that handles the GUI part,
- and {!module:Datascope} that makes the computations.
Some explanations can be found in the code.
frama-c-Magnesium-20151002/doc/code/intro_plugin.txt 0000644 0001750 0001750 00000004401 12645746441 021102 0 ustar mehdi mehdi @ignore
@ignore
@ignore This file is part of Frama-C.
@ignore
@ignore Copyright (C) 2007-2015
@ignore CEA (Commissariat à l'énergie atomique et aux énergies
@ignore alternatives)
@ignore
@ignore you can redistribute it and/or modify it under the terms of the GNU
@ignore Lesser General Public License as published by the Free Software
@ignore Foundation, version 2.1.
@ignore
@ignore It is distributed in the hope that it will be useful,
@ignore but WITHOUT ANY WARRANTY; without even the implied warranty of
@ignore MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
@ignore GNU Lesser General Public License for more details.
@ignore
@ignore See the GNU Lesser General Public License version 2.1
@ignore for more details (enclosed in the file licenses/LGPLv2.1).
@ignore
@ignore
{2 API Documentation}
The _PluginName_ API is dynamically registered:
- {{:../dynamic_plugins/Dynamic_plugins._PluginName_.html} _PluginName_} API
- {{:../dynamic_plugins/Dynamic_plugins.html} Dynamically registered plugins} index
- {{:../index.html}Frama-C} complete kernel API
- {{:../html/Dynamic.html}Dynamic} kernel registry for plugins' API
{2 Plugin Internal Documentation}
- {{:modules.svg}_PluginName_} architecture (SVG format)
- Index of {{:index_modules.html}Modules}
- Index of {{:index_types.html}Types}
- Index of {{:index_values.html}Values}
- Index of {{:index_exceptions.html}Exceptions}
frama-c-Magnesium-20151002/doc/code/intro_slicing.txt 0000644 0001750 0001750 00000010752 12645746441 021242 0 ustar mehdi mehdi @ignore
@ignore
@ignore This file is part of Frama-C.
@ignore
@ignore Copyright (C) 2007-2015
@ignore CEA (Commissariat à l'énergie atomique et aux énergies
@ignore alternatives)
@ignore
@ignore you can redistribute it and/or modify it under the terms of the GNU
@ignore Lesser General Public License as published by the Free Software
@ignore Foundation, version 2.1.
@ignore
@ignore It is distributed in the hope that it will be useful,
@ignore but WITHOUT ANY WARRANTY; without even the implied warranty of
@ignore MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
@ignore GNU Lesser General Public License for more details.
@ignore
@ignore See the GNU Lesser General Public License version 2.1
@ignore for more details (enclosed in the file licenses/LGPLv2.1).
@ignore
@ignore
{2 Overview}
To have more details about what we are trying to do,
you may have a look to the
{{:../../slicing/index.html}specification} report (in French).
The internal types module ({!module:SlicingTypes.Internals})
can give a pretty good idea of the kind of objects that we deal with in this
module.
You can also find some general information below.
{3 Project}
The project was the global repository of the results obtained so far.
If is mainly composed of
a list of actions waiting to be applied,
and the already computed slices.
More precisely, see its type definition
{!type:SlicingTypes.Internals.t_project}
if you want to know what it is composed of,
and the module {!module:SlicingProject} of the functions to handle it.
{3 Program Dependence Graph}
This computation is not part of this module anymore.
See the {{:../html/Db.Pdg.html}API of Pdg module}.
It is enough to know that the PDG of a function is a graph composed
of nodes that represent the elements of a function (declarations, statements,
and so on) and of edges that represent the dependencies relations between those
elements.
{3 Sliced function}
A sliced function contains a mapping between the PDG nodes of a function
and the some marks that are computed by the application of the actions.
It also has a mapping between the function calls and the function called by the
slice that can be either some other slices, or the source function
(or nothing if the call is invisible in that slice).
There can be more than one slice for a source function.
See their type {!type:SlicingTypes.Internals.t_fct_slice},
and the associated functions in {!module:Fct_slice}.
See also {!module:SlicingMarks}
for more information about the low level marks computation.
{3 Actions}
The actions are the way of giving an order to modify the current application.
There are many kinds of actions, but only one is really used to build the
slice which is a list of nodes from the PDG of a function,
and their associated marks.
All the other actions dealing with the marks are first decomposed
before being applied.
Some other actions are can be used to manage the interprocedural part,
ie. which slice to call where.
See the top type {!type:SlicingTypes.Internals.t_criterion} or
the functions in {!module:SlicingActions}.
{3 Options}
The propagation of the marks to the function call depend on a
{!type:SlicingTypes.Internals.t_call_option}.
Chosing this level makes it possible to obtain a more or less precise result.
{3 High level commands}
The module {!module:SlicingCmds} is a bit external because it only uses
the {{:../html/Db.Pdg.html}slicing API} to define higher level function
that are only a composition of the basic functions.
{3 Producing a result }
When there are non more actions in the task list,
the project can be exported. This is done in
{!module:SlicingTransform} module
by building a new CIL application.
frama-c-Magnesium-20151002/doc/code/intro_plugin_default.txt 0000644 0001750 0001750 00000004266 12645746441 022617 0 ustar mehdi mehdi @ignore
@ignore
@ignore This file is part of Frama-C.
@ignore
@ignore Copyright (C) 2007-2015
@ignore CEA (Commissariat à l'énergie atomique et aux énergies
@ignore alternatives)
@ignore
@ignore you can redistribute it and/or modify it under the terms of the GNU
@ignore Lesser General Public License as published by the Free Software
@ignore Foundation, version 2.1.
@ignore
@ignore It is distributed in the hope that it will be useful,
@ignore but WITHOUT ANY WARRANTY; without even the implied warranty of
@ignore MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
@ignore GNU Lesser General Public License for more details.
@ignore
@ignore See the GNU Lesser General Public License version 2.1
@ignore for more details (enclosed in the file licenses/LGPLv2.1).
@ignore
@ignore
{2 API Documentation}
The _PluginName_ API is dynamically registered.
- {{:../index.html}Frama-C} complete kernel API
- {{:../html/Dynamic.html}Dynamic} kernel registry for plugins' API
- {{:../dynamic_plugins/Dynamic_plugins.html} Dynamically registered plugins} API index
{2 Plugin Internal Documentation}
- {{:modules.svg}_PluginName_} architecture (SVG format)
- Index of {{:index_modules.html}Modules}
- Index of {{:index_types.html}Types}
- Index of {{:index_values.html}Values}
- Index of {{:index_exceptions.html}Exceptions}
frama-c-Magnesium-20151002/doc/code/toc_tail.htm 0000644 0001750 0001750 00000003424 12645746441 020144 0 ustar mehdi mehdi