To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
package ocaml-base-compiler
-
dynlink
-
ocamlbytecomp
-
ocamlcommon
-
ocamlmiddleend
-
ocamloptcomp
-
odoc_info
-
runtime_events
-
stdlib
-
str
-
unix
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
ocaml-base-compiler 5.0.0
Libraries
This package provides the following libraries (via ocamlobjinfo):
unix
Documentation:
UnixInterface to the Unix system.UnixLabelsInterface to the Unix system.
threads
Documentation:
str
Documentation:
StrRegular expressions and high-level string processing
runtime_events
Documentation:
Runtime_eventsRuntime events - ring buffer-based runtime tracing
odoc_info
Documentation:
Odoc_configOdoc_messagesOdoc_globalOdoc_typesOdoc_miscOdoc_text_parserOdoc_text_lexerOdoc_textOdoc_nameOdoc_parameterOdoc_valueOdoc_typeOdoc_extensionOdoc_exceptionOdoc_classOdoc_moduleOdoc_printOdoc_strOdoc_comments_globalOdoc_parserOdoc_lexerOdoc_see_lexerOdoc_envOdoc_mergeOdoc_sigOdoc_astOdoc_controlOdoc_inheritOdoc_searchOdoc_scanOdoc_crossOdoc_commentsOdoc_depOdoc_analyseOdoc_infoInterface to the information collected in source files.
dynlink
Documentation:
Dynlink_compilerlibsDynlink_typesDynlink_platform_intfDynlink_commonDynlinkDynamic loading of .cmo, .cma and .cmxs files.
ocamlbytecomp
Documentation:
InstructBytegenPrintinstrEmitcodeBytelinkBytelibrarianBytepackagerErrorsCompileBytecode compilation for .ml and .mli files.Maindriver
ocamlcommon
Documentation:
ConfigSystem configurationBuild_path_prefix_mapRewrite paths for reproducible buildsMiscMiscellaneous useful types and functionsIdentifiableUniform interface for common data structures over various things.NumbersModules about numbers, some of which satisfyIdentifiable.S.Arg_helperDecipher command line arguments of the form <value> | <key>=<value>,...Local_storeThis module provides some facilities for creating references (and hash tables) which can easily be snapshoted and restored to an arbitrary version.Load_pathManagement of include directories.ClflagsCommand line flagsProfileCompiler performance recordingTerminfoBasic interface to the terminfo databaseCcompCompiling C files and building C librariesWarningsWarning definitionsConsistblConsistency tables: for checking consistency of module CRCsStrongly_connected_componentsKosaraju's algorithm for strongly connected components.TargetintTarget processor-native integers.Int_replace_polymorphic_compareDomainstateBinutilsLazy_backtrackDiffingParametric diffingDiffing_with_keysWhen diffing lists where each element has a distinct key, we can refine the diffing patch by introducing two composite edit moves: swaps and moves.LocationSource code locations (ranges of positions), used in parsetree.LongidentLong identifiers, used in parsetree.DocstringsDocumentation commentsSyntaxerrAuxiliary type for reporting syntax errorsAst_helperHelpers to produce Parsetree fragmentsPprintastPretty-printers forParsetreeCamlinternalMenhirLibParserLexerThe lexical analyzerParseEntry points in the parserPrintastRaw printer forParsetreeAst_mapperThe interface of a -ppx rewriterAst_iteratorAst_iterator.iteratorenables AST inspection using open recursion. A typical mapper would be based onAst_iterator.default_iterator, a trivial iterator, and will fall back on it for handling the syntax it does not modify.Attr_helperHelpers for attributesBuiltin_attributesSupport for some of the builtin attributesAst_invariantsCheck AST invariantsDependModule dependencies.IdentPathPrimitiveType_immediacyImmediacy status of a typeShapeTypesBtypeOprintSubstPredefDatareprCmi_formatPersistent_envEnvErrortraceTypedtreeAbstract syntax tree after typingSignature_groupIterate on signature by syntactic group of itemsPrinttypedCtypePrinttypIncludeclassMtypeEnvauxIncludecoreTast_iteratorAllows the implementation of typed tree inspection using open recursionTast_mapperStypesCmt_formatcmt and cmti files format.Cmt2annotUntypeastIncludemodIncludemod_errorprinterTypetexpPrintpatPatternsParmatchDetection of partial matches and unused match cases.Typedecl_propertiesTypedecl_varianceTypedecl_unboxedTypedecl_immediacyTypedecl_separabilityThe OCaml runtime assumes for type-directed optimizations that all types are "separable". A type is "separable" if either all its inhabitants (the values of this type) are floating-point numbers, or none of them are.TypedeclTypeoptRec_checkTypecoreTypeclassTypemodType-checking of the module language and typed ast hooksDebuginfoLambdaPrintlambdaSwitchMatchingTranslobjTranslattributeTranslprimTranslcoreTranslclassTranslmodTmcTail-modulo-cons optimization.SimplifLambda simplification.RuntimedefMetaOpcodesBytesectionsRecording sections written to a bytecode executable fileDllSymtablePparseDriver for the parser and external preprocessors.CompenvMain_argsCompmiscMakedependCompile_commonCommon compilation pipeline between bytecode and native.
ocamlmiddleend
Documentation:
Internal_variable_namesLinkage_nameCompilation_unitVariableVariable.tis the equivalent of a non-persistentIdent.tin theFlambdatree. It wraps anIdent.ttogether with its sourcecompilation_unit. As such, it is unique within a whole program, not just one compilation unit.Closure_elementClosure_idCR-someday lwhite: "Closure_id" is quite a generic name. I wonder whether something like "Closure_label" would better capture that it is the label of a projection.SymbolA symbol identifies a constant provided by either:Backend_varVariables used in the backend, optionally equipped with "provenance" information, used for the emission of debugging information.Clambda_primitivesPrintclambda_primitivesClambdaPrintclambdaSemantics_of_primitivesDescription of the semantics of primitives, to be used for optimization purposes.Convert_primitivesId_typesExport_idTagTags on runtime boxed values.Mutable_variableSet_of_closures_idAn identifier, unique across the whole program, that identifies a set of closures (viz.Set_of_closures).Set_of_closures_originClosure_originVar_within_closureAn identifier, unique across the whole program, that identifies a particular variable within a particular closure. OnlyProject_var, and notVar, nodes are tagged with these identifiers.Static_exceptionAn identifier that is used to label static exceptions. Its uniqueness properties are unspecified.Pass_wrapperAllocated_constConstants that are always allocated (possibly statically). Blocks are not included here since they are always encoded usingPrim (Pmakeblock, ...).ParameterParameter.tcarries a uniqueVariable.tused as function parameter. It can also carry annotations about the usage of the variable.ProjectionRepresentation of projections from closures and blocks.FlambdaIntermediate language used for tree-based analysis and optimization.Flambda_iteratorsFlambda_utilsUtility functions for the Flambda intermediate language.FresheningFreshening of various identifiers.Effect_analysisSimple side effect analysis.Inlining_costMeasurement of the cost (including cost in space) of Flambda terms in the context of inlining.Simple_value_approxSimple approximations to the runtime results of computations. This pass is designed for speed rather than accuracy; the performance is important since it is used heavily during inlining.Export_infoExported information (that is to say, information written into a .cmx file) about a compilation unit.Export_info_for_packTransformations on export information that are only used for the building of packs.CompilenvClosureClosure_middle_endImport_approxCreate simple value approximations from the export information in .cmx files.Lift_codeClosure_conversion_auxEnvironments and auxiliary structures used during closure conversion.Closure_conversionInitialize_symbol_to_let_symbolLift_let_to_initialize_symbolFind_recursive_functions"Recursive functions" are those functionsfthat might call either:Invariant_paramsInconstant_identsAlias_analysisLift_constantsThe aim of this pass is to assign symbols to values known to be constant (in other words, whose values we know at compile time), with appropriate sharing of constants, and replace the occurrences of the constants with their corresponding symbols.Share_constantsShare lifted constants that are eligible for sharing (e.g. not strings) and have equal definitions.Simplify_commonconst_*_expr expr v annot, where the expressionexpris known to evaluate to the valuev, attempt to produce a more simple expression together with its approximation and the benefit gained by replacingexprwith this new expression. This simplification is only performed ifexpris known to have no side effects. Otherwise,expritself is returned, with an appropriate approximation but zero benefit.Remove_unused_argumentsRemove_unused_closure_varsRemove_unused_program_constructsSimplify_boxed_integer_opsSimplify_primitivesInlining_stats_typesInlining_statsInline_and_simplify_auxEnvironments and result structures used during inlining and simplification. (See inline_and_simplify.ml.)Remove_free_vars_equal_to_argsReplace free variables in closures known to be equal to specialised arguments of such closures with those specialised arguments.Extract_projectionsIdentify projections from variables used in function bodies (free variables or specialised args, for example, according towhich_variablesbelow). Projections from variables that are also used boxed are not returned.Augment_specialised_argsHelper module for adding specialised arguments to sets of closures.Unbox_free_vars_of_closuresWhen approximations of free variables of closures indicate that they are closures or blocks, rewrite projections from such blocks to new variables (which become free in the closures), with the defining expressions of the projections lifted out of the corresponding sets of closures.Unbox_specialised_argsWhen approximations of specialised arguments indicate that they are closures or blocks, add more specialised arguments corresponding to the projections from such blocks (with definitions of such projections lifted out), such that the original specialised arguments may later be eliminated.Unbox_closuresTurn free variables of closures into specialised arguments. The aim is to cause the closure to become closed.Inlining_transformsSource code transformations used during inlining.Inlining_decisionSee the Flambda manual chapter for an explanation in prose of the inlining decision procedure.Inline_and_simplifyRef_to_variablesTransformlet-bound references into variables.Flambda_invariantsTraverse_for_exported_symbolsBuild_export_infoConstruct export information, for emission into .cmx files, from an Flambda program.Closure_offsetsAssign numerical offsets, within closure blocks, for code pointers and environment entries.Un_anfFlambda_to_clambdaFlambda_middle_endTranslate Lambda code to Flambda code, optimize it, and produce Clambda.
ocamloptcomp
Documentation:
Internal_variable_namesLinkage_nameCompilation_unitVariableVariable.tis the equivalent of a non-persistentIdent.tin theFlambdatree. It wraps anIdent.ttogether with its sourcecompilation_unit. As such, it is unique within a whole program, not just one compilation unit.Closure_elementClosure_idCR-someday lwhite: "Closure_id" is quite a generic name. I wonder whether something like "Closure_label" would better capture that it is the label of a projection.SymbolA symbol identifies a constant provided by either:Backend_varVariables used in the backend, optionally equipped with "provenance" information, used for the emission of debugging information.Clambda_primitivesPrintclambda_primitivesClambdaPrintclambdaSemantics_of_primitivesDescription of the semantics of primitives, to be used for optimization purposes.Convert_primitivesId_typesExport_idTagTags on runtime boxed values.Mutable_variableSet_of_closures_idAn identifier, unique across the whole program, that identifies a set of closures (viz.Set_of_closures).Set_of_closures_origin