package coq

  1. Overview
  2. Docs
package coq
Legend:
Library
Module
Module type
Parameter
Class
Class type
type class_rawexpr =
  1. | FunClass
  2. | SortClass
  3. | RefClass of Libnames.qualid Constrexpr.or_by_notation

Vernac expressions, produced by the parser

type goal_identifier = string
type scope_name = string
type goal_reference =
  1. | OpenSubgoals
  2. | NthGoal of int
  3. | GoalId of Names.Id.t
type printable =
  1. | PrintTypingFlags
  2. | PrintTables
  3. | PrintFullContext
  4. | PrintSectionContext of Libnames.qualid
  5. | PrintInspect of int
  6. | PrintGrammar of string
  7. | PrintCustomGrammar of string
  8. | PrintLoadPath of Names.DirPath.t option
  9. | PrintLibraries
  10. | PrintModule of Libnames.qualid
  11. | PrintModuleType of Libnames.qualid
  12. | PrintNamespace of Names.DirPath.t
  13. | PrintMLLoadPath
  14. | PrintMLModules
  15. | PrintDebugGC
  16. | PrintName of Libnames.qualid Constrexpr.or_by_notation * UnivNames.univ_name_list option
  17. | PrintGraph
  18. | PrintClasses
  19. | PrintTypeClasses
  20. | PrintInstances of Libnames.qualid Constrexpr.or_by_notation
  21. | PrintCoercions
  22. | PrintCoercionPaths of class_rawexpr * class_rawexpr
  23. | PrintCanonicalConversions of Libnames.qualid Constrexpr.or_by_notation list
  24. | PrintUniverses of bool * Libnames.qualid list option * string option
  25. | PrintHint of Libnames.qualid Constrexpr.or_by_notation
  26. | PrintHintGoal
  27. | PrintHintDbName of string
  28. | PrintHintDb
  29. | PrintScopes
  30. | PrintScope of string
  31. | PrintVisibility of string option
  32. | PrintAbout of Libnames.qualid Constrexpr.or_by_notation * UnivNames.univ_name_list option * Goal_select.t option
  33. | PrintImplicit of Libnames.qualid Constrexpr.or_by_notation
  34. | PrintAssumptions of bool * bool * Libnames.qualid Constrexpr.or_by_notation
  35. | PrintStrategy of Libnames.qualid Constrexpr.or_by_notation option
  36. | PrintRegistered
  37. | PrintNotation of Constrexpr.notation_entry * string
type glob_search_where =
  1. | InHyp
  2. | InConcl
  3. | Anywhere
type search_item =
  1. | SearchSubPattern of glob_search_where * bool * Constrexpr.constr_pattern_expr
  2. | SearchString of glob_search_where * bool * string * scope_name option
  3. | SearchKind of Decls.logical_kind
type search_request =
  1. | SearchLiteral of search_item
  2. | SearchDisjConj of (bool * search_request) list list
type searchable =
  1. | SearchPattern of Constrexpr.constr_pattern_expr
  2. | SearchRewrite of Constrexpr.constr_pattern_expr
  3. | Search of (bool * search_request) list
type locatable =
  1. | LocateAny of Libnames.qualid Constrexpr.or_by_notation
  2. | LocateTerm of Libnames.qualid Constrexpr.or_by_notation
  3. | LocateLibrary of Libnames.qualid
  4. | LocateModule of Libnames.qualid
  5. | LocateOther of string * Libnames.qualid
  6. | LocateFile of string
type showable =
  1. | ShowGoal of goal_reference
  2. | ShowProof
  3. | ShowExistentials
  4. | ShowUniverses
  5. | ShowProofNames
  6. | ShowIntros of bool
  7. | ShowMatch of Libnames.qualid
type comment =
  1. | CommentConstr of Constrexpr.constr_expr
  2. | CommentString of string
  3. | CommentInt of int
type search_restriction =
  1. | SearchInside of Libnames.qualid list
  2. | SearchOutside of Libnames.qualid list
type verbose_flag = bool
type coercion_flag = bool
type instance_flag =
  1. | BackInstance
  2. | NoInstance
type export_flag = Lib.export_flag =
  1. | Export
  2. | Import
type import_categories = {
  1. negative : bool;
  2. import_cats : string CAst.t list;
}
type export_with_cats = export_flag * import_categories option
type infix_flag = bool
type one_import_filter_name = Libnames.qualid * bool
type import_filter_expr =
  1. | ImportAll
  2. | ImportNames of one_import_filter_name list
type locality_flag = bool
type option_setting =
  1. | OptionUnset
  2. | OptionSetTrue
  3. | OptionSetInt of int
  4. | OptionSetString of string

Identifier and optional list of bound universes and constraints.

type notation_format =
  1. | TextFormat of Names.lstring
  2. | ExtraFormat of string * Names.lstring
type syntax_modifier =
  1. | SetItemLevel of string list * Notation_term.constr_as_binder_kind option * Extend.production_level
  2. | SetItemScope of string list * scope_name
  3. | SetLevel of int
  4. | SetCustomEntry of string * int option
  5. | SetAssoc of Gramlib.Gramext.g_assoc
  6. | SetEntryType of string * Extend.simple_constr_prod_entry_key
  7. | SetOnlyParsing
  8. | SetOnlyPrinting
  9. | SetFormat of notation_format
type decl_notation = {
  1. decl_ntn_string : Names.lstring;
  2. decl_ntn_interp : Constrexpr.constr_expr;
  3. decl_ntn_scope : scope_name option;
  4. decl_ntn_modifiers : syntax_modifier CAst.t list;
}
type 'a fix_expr_gen = {
  1. fname : Names.lident;
  2. univs : Constrexpr.universe_decl_expr option;
  3. rec_order : 'a;
  4. binders : Constrexpr.local_binder_expr list;
  5. rtype : Constrexpr.constr_expr;
  6. body_def : Constrexpr.constr_expr option;
  7. notations : decl_notation list;
}
type fixpoint_expr = Constrexpr.recursion_order_expr option fix_expr_gen
type cofixpoint_expr = unit fix_expr_gen
type inductive_kind =
  1. | Inductive_kw
  2. | CoInductive
  3. | Variant
  4. | Record
  5. | Structure
  6. | Class of bool
type simple_binder = Names.lident list * Constrexpr.constr_expr
type class_binder = Names.lident * Constrexpr.constr_expr list
type 'a with_coercion = coercion_flag * 'a
type record_field_attr = {
  1. rf_subclass : instance_flag;
  2. rf_reverse : bool option;
  3. rf_priority : int option;
  4. rf_notation : decl_notation list;
  5. rf_canonical : bool;
}
type constructor_list_or_record_decl_expr =
  1. | Constructors of constructor_expr list
  2. | RecordDecl of Names.lident option * (local_decl_expr * record_field_attr) list * Names.lident option
type inductive_params_expr = Constrexpr.local_binder_expr list * Constrexpr.local_binder_expr list option

If the option is nonempty the "|" marker was used

and typeclass_context = typeclass_constraint list
type opacity_flag =
  1. | Opaque
  2. | Transparent
type proof_end =
  1. | Admitted
  2. | Proved of opacity_flag * Names.lident option
type scheme_type =
  1. | SchemeInduction
  2. | SchemeMinimality
  3. | SchemeElimination
  4. | SchemeCase
type equality_scheme_type =
  1. | SchemeBooleanEquality
  2. | SchemeEquality
type scheme = {
  1. sch_type : scheme_type;
  2. sch_qualid : Libnames.qualid Constrexpr.or_by_notation;
  3. sch_sort : Sorts.family;
}
type section_subset_expr =
  1. | SsEmpty
  2. | SsType
  3. | SsSingl of Names.lident
  4. | SsCompl of section_subset_expr
  5. | SsUnion of section_subset_expr * section_subset_expr
  6. | SsSubstr of section_subset_expr * section_subset_expr
  7. | SsFwdClose of section_subset_expr

Extension identifiers for the VERNAC EXTEND mechanism.

("Extraction", 0 indicates Extraction qualid command.

("Extraction", 1 indicates Recursive Extraction qualid command.

("Extraction", 2) indicates Extraction "filename" qualid1 ... qualidn command.

("ExtractionLibrary", 0) indicates Extraction Library ident command.

("RecursiveExtractionLibrary", 0) indicates Recursive Extraction Library ident command.

("SeparateExtraction", 0) indicates Separate Extraction qualid1 ... qualidn command.

("ExtractionLanguage", 0) indicates Extraction Language Ocaml or Extraction Language Haskell or Extraction Language Scheme or Extraction Language JSON commands.

("ExtractionImplicit", 0) indicates Extraction Implicit qualid [ ident1 ... identn ] command.

("ExtractionConstant", 0) indicates Extract Constant qualid => string command.

("ExtractionInlinedConstant", 0) indicates Extract Inlined Constant qualid => string command.

("ExtractionInductive", 0) indicates Extract Inductive qualid => string {i string} ... {string} optstring command.

("ExtractionBlacklist", 0) indicates Extraction Blacklist ident1 ... identn command.

type register_kind =
  1. | RegisterInline
  2. | RegisterCoqlib of Libnames.qualid
Types concerning the module layer
type module_binder = export_with_cats option * Names.lident list * module_ast_inl
The type of vernacular expressions
type vernac_one_argument_status = {
  1. name : Names.Name.t;
  2. recarg_like : bool;
  3. notation_scope : string CAst.t option;
  4. implicit_status : Glob_term.binding_kind;
}
type vernac_argument_status =
  1. | VolatileArg
  2. | BidiArg
  3. | RealArg of vernac_one_argument_status
type arguments_modifier = [
  1. | `Assert
  2. | `ClearBidiHint
  3. | `ClearImplicits
  4. | `ClearScopes
  5. | `DefaultImplicits
  6. | `ExtraScopes
  7. | `ReductionDontExposeCase
  8. | `ReductionNeverUnfold
  9. | `Rename
]
type extend_name = string * int
type discharge =
  1. | DoDischarge
  2. | NoDischarge
type reference_or_constr =
  1. | HintsReference of Libnames.qualid
  2. | HintsConstr of Constrexpr.constr_expr
type hints_expr =
  1. | HintsResolve of (hint_info_expr * bool * reference_or_constr) list
  2. | HintsResolveIFF of bool * Libnames.qualid list * int option
  3. | HintsImmediate of reference_or_constr list
  4. | HintsUnfold of Libnames.qualid list
  5. | HintsTransparency of Libnames.qualid Hints.hints_transparency_target * bool
  6. | HintsMode of Libnames.qualid * Hints.hint_mode list
  7. | HintsConstructors of Libnames.qualid list
  8. | HintsExtern of int * Constrexpr.constr_expr option * Genarg.raw_generic_argument
type nonrec vernac_expr =
  1. | VernacLoad of verbose_flag * string
  2. | VernacReservedNotation of infix_flag * Names.lstring * syntax_modifier CAst.t list
  3. | VernacOpenCloseScope of bool * scope_name
  4. | VernacDeclareScope of scope_name
  5. | VernacDelimiters of scope_name * string option
  6. | VernacBindScope of scope_name * class_rawexpr list
  7. | VernacNotation of infix_flag * Constrexpr.constr_expr * Names.lstring * syntax_modifier CAst.t list * scope_name option
  8. | VernacNotationAddFormat of string * string * string
  9. | VernacDeclareCustomEntry of string
  10. | VernacDefinition of discharge * Decls.definition_object_kind * Constrexpr.name_decl * definition_expr
  11. | VernacStartTheoremProof of Decls.theorem_kind * proof_expr list
  12. | VernacEndProof of proof_end
  13. | VernacExactProof of Constrexpr.constr_expr
  14. | VernacAssumption of discharge * Decls.assumption_object_kind * Declaremods.inline * (Constrexpr.ident_decl list * Constrexpr.constr_expr) with_coercion list
  15. | VernacInductive of inductive_kind * (inductive_expr * decl_notation list) list
  16. | VernacFixpoint of discharge * fixpoint_expr list
  17. | VernacCoFixpoint of discharge * cofixpoint_expr list
  18. | VernacScheme of (Names.lident option * scheme) list
  19. | VernacSchemeEquality of equality_scheme_type * Libnames.qualid Constrexpr.or_by_notation
  20. | VernacCombinedScheme of Names.lident * Names.lident list
  21. | VernacUniverse of Names.lident list
  22. | VernacConstraint of Constrexpr.univ_constraint_expr list
  23. | VernacBeginSection of Names.lident
  24. | VernacEndSegment of Names.lident
  25. | VernacExtraDependency of Libnames.qualid * string * Names.Id.t option
  26. | VernacRequire of Libnames.qualid option * export_with_cats option * (Libnames.qualid * import_filter_expr) list
  27. | VernacImport of export_with_cats * (Libnames.qualid * import_filter_expr) list
  28. | VernacCanonical of Libnames.qualid Constrexpr.or_by_notation
  29. | VernacCoercion of Libnames.qualid Constrexpr.or_by_notation * (class_rawexpr * class_rawexpr) option
  30. | VernacIdentityCoercion of Names.lident * class_rawexpr * class_rawexpr
  31. | VernacNameSectionHypSet of Names.lident * section_subset_expr
  32. | VernacInstance of Constrexpr.name_decl * Constrexpr.local_binder_expr list * Constrexpr.constr_expr * (bool * Constrexpr.constr_expr) option * hint_info_expr
  33. | VernacDeclareInstance of Constrexpr.ident_decl * Constrexpr.local_binder_expr list * Constrexpr.constr_expr * hint_info_expr
  34. | VernacContext of Constrexpr.local_binder_expr list
  35. | VernacExistingInstance of (Libnames.qualid * hint_info_expr) list
  36. | VernacExistingClass of Libnames.qualid
  37. | VernacDeclareModule of export_with_cats option * Names.lident * module_binder list * module_ast_inl
  38. | VernacDefineModule of export_with_cats option * Names.lident * module_binder list * module_ast_inl Declaremods.module_signature * module_ast_inl list
  39. | VernacDeclareModuleType of Names.lident * module_binder list * module_ast_inl list * module_ast_inl list
  40. | VernacInclude of module_ast_inl list
  41. | VernacAddLoadPath of {
    1. implicit : bool;
    2. physical_path : CUnix.physical_path;
    3. logical_path : Names.DirPath.t;
    }
  42. | VernacRemoveLoadPath of string
  43. | VernacAddMLPath of string
  44. | VernacDeclareMLModule of string list
  45. | VernacChdir of string option
  46. | VernacResetName of Names.lident
  47. | VernacResetInitial
  48. | VernacBack of int
  49. | VernacCreateHintDb of string * bool
  50. | VernacRemoveHints of string list * Libnames.qualid list
  51. | VernacHints of string list * hints_expr
  52. | VernacSyntacticDefinition of Names.lident * Names.Id.t list * Constrexpr.constr_expr * syntax_modifier CAst.t list
  53. | VernacArguments of Libnames.qualid Constrexpr.or_by_notation * vernac_argument_status list * (Names.Name.t * Glob_term.binding_kind) list list * arguments_modifier list
  54. | VernacReserve of simple_binder list
  55. | VernacGeneralizable of Names.lident list option
  56. | VernacSetOpacity of Conv_oracle.level * Libnames.qualid Constrexpr.or_by_notation list
  57. | VernacSetStrategy of (Conv_oracle.level * Libnames.qualid Constrexpr.or_by_notation list) list
  58. | VernacSetOption of bool * Goptions.option_name * option_setting
  59. | VernacAddOption of Goptions.option_name * Goptions.table_value list
  60. | VernacRemoveOption of Goptions.option_name * Goptions.table_value list
  61. | VernacMemOption of Goptions.option_name * Goptions.table_value list
  62. | VernacPrintOption of Goptions.option_name
  63. | VernacCheckMayEval of Genredexpr.raw_red_expr option * Goal_select.t option * Constrexpr.constr_expr
  64. | VernacGlobalCheck of Constrexpr.constr_expr
  65. | VernacDeclareReduction of string * Genredexpr.raw_red_expr
  66. | VernacPrint of printable
  67. | VernacSearch of searchable * Goal_select.t option * search_restriction
  68. | VernacLocate of locatable
  69. | VernacRegister of Libnames.qualid * register_kind
  70. | VernacPrimitive of Constrexpr.ident_decl * CPrimitives.op_or_type * Constrexpr.constr_expr option
  71. | VernacComments of comment list
  72. | VernacAbort
  73. | VernacAbortAll
  74. | VernacRestart
  75. | VernacUndo of int
  76. | VernacUndoTo of int
  77. | VernacFocus of int option
  78. | VernacUnfocus
  79. | VernacUnfocused
  80. | VernacBullet of Proof_bullet.t
  81. | VernacSubproof of Goal_select.t option
  82. | VernacEndSubproof
  83. | VernacShow of showable
  84. | VernacCheckGuard
  85. | VernacProof of Genarg.raw_generic_argument option * section_subset_expr option
  86. | VernacProofMode of string
  87. | VernacExtend of extend_name * Genarg.raw_generic_argument list
type control_flag =
  1. | ControlTime of bool
  2. | ControlRedirect of string
  3. | ControlTimeout of int
  4. | ControlFail
  5. | ControlSucceed
type vernac_control_r = {
  1. control : control_flag list;
  2. attrs : Attributes.vernac_flags;
  3. expr : vernac_expr;
}
and vernac_control = vernac_control_r CAst.t