package comby

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Pipeline

comby
- Comby
  - Match
    
    Environment
    
    Location
    
    Range
  - Matchers
    
    Alpha
    
    Assembly
    
    Bash
    
    C
    
    CSS
    
    C_nested_comments
    
    Clojure
    
    Coq
    
    Csharp
    
    Dart
    
    Dhall
    
    Dyck
    
    Elixir
    
    Elm
    
    Erlang
    
    Fortran
    
    Fsharp
    
    Generic
    
    Go
    
    GraphQL
    
    Haskell
    
    Html
    
    JSON
    
    JSONC
    
    Java
    
    Javascript
    
    Jsx
    
    Julia
    
    Kotlin
    
    Latex
    
    Lisp
    
    Move
    
    Nim
    
    OCaml
    
    Paren
    
    Pascal
    
    Php
    
    Python
    
    Reason
    
    Ruby
    
    Rust
    
    SQL
    
    Scala
    
    Solidity
    
    Swift
    
    Text
    
    Tsx
    
    Typescript
    
    Xml
    
    Zig
    
    Configuration
    
    Hole
    
    Matcher
    
    S
    
    Metasyntax
    
    S
    
    Syntax
    
    S
  - Pipeline
    
    Specification
  - Replacement
  - Rewrite
  - Rule
comby.camlzip
- Camlzip
  - Gzip
  - Zip
  - Zlib
comby.configuration
- Configuration
comby.interactive
- Interactive
  - Diff
comby.patdiff
- Patdiff
  - Compare_core
  - Configuration
    
    On_disk
    
    V0
    
    V1
  - Patdiff_core
  - Private
comby.patdiff_kernel
- Patdiff_kernel
  - Ansi_output
    
    Rule
  - Ascii_output
    
    Rule
  - Comparison_result
  - Configuration
    
    Fields
    
    Direct
    
    Private
  - Diff_input
    
    Fields
    
    Direct
  - File_name
  - Float_tolerance
  - Format
    
    Color
    
    Gray24
    
    Map
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    RGB6
    
    Set
    
    Elt
    
    Named
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Named
    
    Provide_of_sexp
    
    Elt
    
    Location_style
    
    Rule
    
    Affix
    
    Rules
    
    Style
    
    Map
    
    Key
    
    Provide_hash
    
    Provide_of_sexp
    
    Key
    
    Tree
    
    Provide_of_sexp
    
    K
    
    Set
    
    Elt
    
    Named
    
    Provide_hash
    
    Provide_of_sexp
    
    Elt
    
    Tree
    
    Named
    
    Provide_of_sexp
    
    Elt
  - Html_output
    
    Private
    
    Make
    
    Mtime
    
    Rule
    
    Without_mtime
    
    Rule
  - Hunks
  - Import
  - Is_binary
  - Output
    
    S
    
    Rule
  - Patdiff_core
    
    Private
    
    Make
    
    Output_impls
    
    S
    
    Without_unix
  - Should_keep_whitespace
comby.pipeline
- Pipeline
comby.statistics
- Statistics
  - Time

Legend:
Library
Module
Module type
Parameter
Class
Class type

Pipeline

Exposes top level functions for running matchers and generating replacements. For finer control over matching and rewriting, use Matcher.all to generate matches, and then process matches with Rewrite functions.

type single_source =

| Path of string
| String of string

Source inputs for a pipeline is either a string, or a file path.

module Specification : sig ... end

type specification = Specification.t

type output =

| Matches of match' list * int
| Replacement of Replacement.t list * string * int
| Nothing

The output of running a specification. Matches are a list of matches and the number of matches found. A Replacement consists of the list of replacement fragments, the rewrite output, and the number of replacements made.

val execute : 
  (module Matchers.Matcher.S) ->
  ?substitute_in_place:bool ->
  ?timeout:int ->
  ?metasyntax:Matchers.metasyntax ->
  ?fresh:(unit -> string) ->
  ?configuration:Matchers.configuration ->
  single_source ->
  specification ->
  output

execute matcher subst timeout metasyntax fresh config source spec runs a matcher on source for spec parameterized by config. subst sets whether rewrite output should substitute rewritten values in place. timeout specifies a timeout in seconds (default 3). If metasyntax is defined, rewrite operations will respect custom metasyntax definitions. Note that metasyntax here does not affect matching: matcher should be defined with a metasyntax definition if desired. A custom fresh variable generator may supply values to use for substitution; see Rewrite.substitute for more.