package comby

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Rewrite

package comby

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

Rewrite

Defines rewrite operations.

val all : 
  ?source:string ->
  ?metasyntax:Matchers.metasyntax ->
  ?fresh:(unit -> string) ->
  rewrite_template:string ->
  match' list ->
  replacement option

all source metasyntax fresh rewrite_template matches substitutes rewrite_template with each match in matches to create a rewrite result. If source is specified, each rewrite result is substituted in-place in the source. If source is not specified, rewritten matches are newline-separated. If metasyntax is defined, the rewrite template will respect custom metasyntax definitions.

If the rewrite template contains the syntax :id(), then it is substituted with fresh values. fresh may be specified to supply custom fresh values. If not specified, fresh variables are generated in increasing rank starting with 1, and incremented. See substitute for more.

val substitute : 
  ?metasyntax:Matchers.metasyntax ->
  ?fresh:(unit -> string) ->
  string ->
  Match.environment ->
  string * string list

substitute metasyntax fresh template environment substitutes template with the variable and value pairs in the environment. It returns the result after substitution, and the list of variables in environment that were substituted for. If metasyntax is defined, the rewrite template will respect custom metasyntax definitions.

The syntax :id() is substituted with fresh values. If fresh is not specified, the default behavior substitutes :id() starting with 1, and subsequent :id() values increment the ID. If fresh is set, substitutes the pattern :id() with the value of fresh () as the hole is encountered, left to right.