markedsource

Documentation

Overview

Package markedsource defines functions for rendering MarkedSource.

Index

• func Render(ms *cpb.MarkedSource) string
• func RenderCallSiteSignature(node *cpb.MarkedSource) string
• func RenderInitializer(node *cpb.MarkedSource, format ContentType, linkify func(string) string) string
• func RenderQualifiedName(ms *cpb.MarkedSource) *cpb.SymbolInfo
• func RenderSignature(node *cpb.MarkedSource, format ContentType, linkify func(string) string) string
• func RenderSimpleIdentifier(node *cpb.MarkedSource, format ContentType, linkify func(string) string) string
• func RenderSimpleParams(node *cpb.MarkedSource, format ContentType, linkify func(string) string) []string
• func RenderSimpleQualifiedName(node *cpb.MarkedSource, includeIdentifier bool, format ContentType, ...) string
• type ContentType
• type Resolver
  • func NewResolver(entries []*spb.Entry) (*Resolver, error)
  • func (r *Resolver) Resolve(src *spb.VName) *cpb.MarkedSource
  • func (r *Resolver) ResolveTicket(ticket string) *cpb.MarkedSource

Functions

func Render

func Render(ms *cpb.MarkedSource) string

Render flattens MarkedSource to a string using reasonable defaults.

func RenderCallSiteSignature

func RenderCallSiteSignature(node *cpb.MarkedSource) string

RenderCallSiteSignature returns the text snippet for a callsite as plaintext.

func RenderInitializer

func RenderInitializer(node *cpb.MarkedSource, format ContentType, linkify func(string) string) string

RenderInitializer extracts and renders a plaintext initializer from node. If not nil, linkify will be used to generate link URIs from semantic node tickets. It may return an empty string if there is no available URI.

func RenderQualifiedName

func RenderQualifiedName(ms *cpb.MarkedSource) *cpb.SymbolInfo

RenderQualifiedName renders a language-appropriate qualified name from a MarkedSource message.

func RenderSignature

func RenderSignature(node *cpb.MarkedSource, format ContentType, linkify func(string) string) string

RenderSignature renders the full signature from node. If not nil, linkify will be used to generate link URIs from semantic node tickets. It may return an empty string if there is no available URI.

func RenderSimpleIdentifier

func RenderSimpleIdentifier(node *cpb.MarkedSource, format ContentType, linkify func(string) string) string

RenderSimpleIdentifier extracts and renders a the simple identifier from node. If not nil, linkify will be used to generate link URIs from semantic node tickets. It may return an empty string if there is no available URI.

func RenderSimpleParams

func RenderSimpleParams(node *cpb.MarkedSource, format ContentType, linkify func(string) string) []string

RenderSimpleParams extracts and renders the simple identifiers for parameters in node. If not nil, linkify will be used to generate link URIs from semantic node tickets. It may return an empty string if there is no available URI.

func RenderSimpleQualifiedName

func RenderSimpleQualifiedName(node *cpb.MarkedSource, includeIdentifier bool, format ContentType, linkify func(string) string) string

RenderSimpleQualifiedName extracts and renders the simple qualified name from node. If includeIdentifier is true it includes the identifier on the qualified name. If not nil, linkify will be used to generate link URIs from semantic node tickets. It may return an empty string if there is no available URI.

Types

type ContentType

type ContentType string

ContentType is a type of rendering output.

var (
	PlaintextContent ContentType = "txt"
	MarkdownContent  ContentType = "md"
)

Supported list of ContentTypes

type Resolver

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

Resolver produces fully resolved MarkedSources from a set of entries.

func NewResolver

func NewResolver(entries []*spb.Entry) (*Resolver, error)

NewResolver constructs a MarkedSource resolver from the given entries.

func (*Resolver) Resolve

func (r *Resolver) Resolve(src *spb.VName) *cpb.MarkedSource

Resolve returns the fully resolved MarkedSource for the given source VName. May return nil if no MarkedSource is found.

func (*Resolver) ResolveTicket

func (r *Resolver) ResolveTicket(ticket string) *cpb.MarkedSource

ResolveTicket returns the fully resolved MarkedSource for the given source ticket. May return nil if no MarkedSource is found.