syntax

Documentation

Overview

Package syntax contains the syntax for reading and writing graphs to files. It also comes with predefined variables for common syntaxes. The syntax struct assumes that every edge is written in a single line.

Index

• Constants
• Variables
• type Syntax
  • func Parse(s string) ([]*Syntax, error)

Constants

const IGNOREFIELD = ""

to be used in Syntax to indicate that the field is not available in the syntax

Variables

var Dot = &Syntax{
	GraphPrefix:     "digraph{",
	EdgePrefix:      "",
	SourceDelimiter: "",
	EdgeInfix:       "->",
	TargetDelimiter: "",
	EdgeSuffix:      ";",
	GraphSuffix:     "}",
	StripWhitespace: true,
}

var MakeCall = []*Syntax{
	{
		GraphPrefix:     "",
		EdgePrefix:      "$(call DEPEND_ALL,",
		SourceDelimiter: "",
		EdgeInfix:       ",",
		TargetDelimiter: ",",
		EdgeSuffix:      ")",
		GraphSuffix:     "",
		StripWhitespace: true,
	},
	{
		GraphPrefix:     "",
		EdgePrefix:      "$(call ALL_SPECS,",
		SourceDelimiter: ",",
		EdgeInfix:       "):",
		TargetDelimiter: " ",
		EdgeSuffix:      "",
		GraphSuffix:     "",
		StripWhitespace: true,
	},
}

var Makefile = &Syntax{
	GraphPrefix:     "",
	EdgePrefix:      "",
	SourceDelimiter: " ",
	EdgeInfix:       ":",
	TargetDelimiter: " ",
	EdgeSuffix:      "",
	GraphSuffix:     "",
	StripWhitespace: true,
}

Types

type Syntax

type Syntax struct {
	GraphPrefix     string
	EdgePrefix      string
	SourceDelimiter string
	EdgeInfix       string
	TargetDelimiter string
	EdgeSuffix      string
	GraphSuffix     string
	StripWhitespace bool
}

func Parse

func Parse(s string) ([]*Syntax, error)

Parse parses new syntaxes from the given string, supporting various formats.