catalogdiagrams

README

package catalogdiagrams is a re-write of a whole bunch of internal sysl diagramming code but with fixes so that it can work better with the markdown generator, for example it can recursively get all types unlike the sysl datamodeldiagram package

Documentation

Index

• func GenerateDataModel(parentAppName string, t TypeMap) string
• type DataModelParam
• type DataModelView
  • func (v *DataModelView) GenerateDataView(dataParam *DataModelParam, appName string, tMap TypeMap) string
• type TypeData
  • func NewTypeData(alias string, t *sysl.Type) *TypeData
  • func TypeFromRef(mod *sysl.Module, appName string, t *TypeData) (string, string, *TypeData)
• type TypeMap
  • func FromSyslTypeMap(appName string, t map[string]*sysl.Type) TypeMap
  • func RecursivelyGetTypes(appName string, types TypeMap, m *sysl.Module) TypeMap
  • func RecursivelyGetTypesHelper(appName string, t *TypeData, m *sysl.Module, cummulative TypeMap) TypeMap

Functions

func GenerateDataModel

func GenerateDataModel(parentAppName string, t TypeMap) string

GenerateDataModel takes all the types in parentAppName and generates data model diagrams for it

Types

type DataModelParam

type DataModelParam struct {
	datamodeldiagram.DataModelParam
}

type DataModelView

type DataModelView struct {
	datamodeldiagram.DataModelView
}

func (*DataModelView) GenerateDataView

func (v *DataModelView) GenerateDataView(dataParam *DataModelParam, appName string, tMap TypeMap) string

type TypeData

type TypeData struct {
	// contains filtered or unexported fields
}

func NewTypeData

func NewTypeData(alias string, t *sysl.Type) *TypeData

func TypeFromRef

func TypeFromRef(mod *sysl.Module, appName string, t *TypeData) (string, string, *TypeData)

TypeFromRef take a type data and recursively traverse through TypeRefs and fetch the actual type data.

type TypeMap

type TypeMap map[string]*TypeData

func FromSyslTypeMap

func FromSyslTypeMap(appName string, t map[string]*sysl.Type) TypeMap

func RecursivelyGetTypes

func RecursivelyGetTypes(appName string, types TypeMap, m *sysl.Module) TypeMap

func RecursivelyGetTypesHelper

func RecursivelyGetTypesHelper(appName string, t *TypeData, m *sysl.Module, cummulative TypeMap) TypeMap

RecursivelyGetTypesHelper gets returns a type map of a type and all of its fields recursively.