Ancestor of all productions

# Ancestor of all productions
# A production is a node without text but that usually has children.
abstract class Prod
	super ANode

	# All the annotations attached directly to the node
	var n_annotations: nullable AAnnotations = null is writable

	# Return all its annotations of a given name in the order of their declaration
	# Retun an empty array if no such an annotation.
	fun get_annotations(name: String): Array[AAnnotation]
	do
		var res = new Array[AAnnotation]
		var nas = n_annotations
		if nas != null then for na in nas.n_items do
			if na.name != name then continue
			res.add(na)
		end
		if self isa AClassdef then for na in n_propdefs do
			if na isa AAnnotPropdef then
				if na.name != name then continue
				res.add na
			end
		end

		return res
	end

	redef fun replace_with(n: ANode)
	do
		super
		assert n isa Prod
		if not isset n._location and isset _location then n._location = _location
	end
end

src/parser/parser_nodes.nit:424,1--458,3

nitc :: parser_work $ Prod

redef class Prod
	# Location on the first token after the start of a production
	# So outside the production for epsilon production
	var first_location: nullable Location

	# Join the text of all visited tokens
	fun collect_text: String
	do
		var v = new TextCollectorVisitor
		v.enter_visit(self)
		assert v.text != ""
		return v.text
	end
end

src/parser/parser_work.nit:161,1--174,3

nitc :: astutil $ Prod

redef class Prod
	# The first token of the production in the AST
	# Computed by `parentize_tokens`
	var first_token: nullable Token = null

	# The last token of the production in the AST
	# Computed by `parentize_tokens`
	var last_token: nullable Token = null

	# Is the production contained in full block of line?
	# Computed by `parentize_tokens`
	fun is_block: Bool
	do
		if first_token == null or last_token == null then return false
		#sys.stderr.write "{self}@{location}: start={first_token.is_starting_line} {first_token.inspect}@{first_token.location} ; end={last_token.is_ending_line} {last_token.inspect}@{last_token.location}\n"
		return first_token.is_starting_line and last_token.is_ending_line
	end

	# Is the production a part of a single line (without being a block)
	# Computed by `parentize_tokens`
	fun is_span: Bool
	do
		if first_token == null or last_token == null then return false
		return not is_block and location.line_start == location.line_end
	end

	# A XML representation of the AST
	# Productions and token become elements
	# 
	# detached tokens and whitespaces are preserved in the XML
	# 
	# ~~~
	# import parser_util
	# var text = "y += foo"
	# var ast = (new ToolContext).parse_something(text)
	# assert ast isa AExpr
	# ast.parentize_tokens
	# assert ast.to_xml.write_to_string == """<ACallReassignExpr><AQid><TId>y</TId></AQid> <APlusAssignOp><TPluseq>+=</TPluseq></APlusAssignOp> <ACallExpr><AQid><TId>foo</TId></AQid></ACallExpr></ACallReassignExpr>"""
	# ~~~
	fun to_xml: HTMLTag
	do
		var res = new HTMLTag("AST")
		var stack = new Array[HTMLTag]
		var c = first_token
		while c != null do
			if c != first_token then res.append(c.blank_before)
			var sp = c.starting_prods
			if sp != null then for p in sp do
				var tag = new HTMLTag(p.class_name)
				res.add tag
				stack.add res
				res = tag
			end
			var tag = new HTMLTag(c.class_name)
			res.add tag
			tag.append c.text
			var ep = c.ending_prods
			if ep != null then for p in ep do
				res = stack.pop
			end

			if c == last_token then
				c = null
			else
				c = c.next_token
			end
		end
		assert stack.is_empty
		return res.children.first
	end
end

src/astutil.nit:37,1--107,3

nitc :: annotation $ Prod

redef class Prod
	super ANode

	# Try to get its single annotation with a given name
	# If there is no such an annotation, null is returned.
	# If there is more than one annotation, a error message is printed and the first annotation is returned
	fun get_single_annotation(name: String, modelbuilder: ModelBuilder): nullable AAnnotation
	do
		var res = get_annotations(name)
		if res.is_empty then return null
		if res.length > 1 then
			modelbuilder.error(res[1], "Syntax Error: multiple `{name}`. A previous one is defined line {res[0].location.line_start}.")
		end
		return res.first
	end
end

src/annotation.nit:22,1--37,3

nitc :: pretty $ Prod

redef class Prod
	redef fun accept_pretty_printer(v) do v.visit first_token

	# The token where the production really start (skipping ADoc).
	private fun start_token: nullable Token do return first_token

	# Collect all `TComment` contained in the production
	# (between `start_token` and `end_token`).
	private fun collect_comments: Array[TComment] do
		var res = new Array[TComment]
		if start_token == null or last_token == null then return res
		var token = start_token

		while token != last_token do
			if token isa TComment then res.add token
			token = token.next_token
		end

		return res
	end

	redef fun collect_length do
		var res = 0
		if start_token == null or last_token == null then return res
		var token = start_token

		while token != last_token do
			res += token.text.length
			token = token.next_token
		end

		res += token.text.length
		return res
	end

	redef fun was_inline do
		return start_token.location.line_start == last_token.location.line_end
	end
end

src/pretty.nit:370,1--408,3

abstract class Prod

Summary

Ancestor of all productions

Introduced properties

_first_location

_first_token

_last_token

_n_annotations

collect_comments

collect_text

defaultinit

first_location

first_location=

first_token

first_token=

get_annotations

get_single_annotation

is_block

is_span

last_token

last_token=

n_annotations

n_annotations=

start_token

to_xml

Redefined properties

SELF

accept_pretty_printer

collect_length

replace_with

was_inline

Ancestor of all productions

Introduced properties

private var _first_location: nullable Location

private var _first_token: nullable Token

private var _last_token: nullable Token

private var _n_annotations: nullable AAnnotations

private fun collect_comments: Array[TComment]

fun collect_text: String

init defaultinit

fun first_location: nullable Location

protected fun first_location=(first_location: nullable Location)

fun first_token: nullable Token

protected fun first_token=(first_token: nullable Token)

fun get_annotations(name: String): Array[AAnnotation]

fun get_single_annotation(name: String, modelbuilder: ModelBuilder): nullable AAnnotation

fun is_block: Bool

fun is_span: Bool

fun last_token: nullable Token

protected fun last_token=(last_token: nullable Token)

fun n_annotations: nullable AAnnotations

fun n_annotations=(n_annotations: nullable AAnnotations)

private fun start_token: nullable Token

fun to_xml: HTMLTag

Redefined properties

redef type SELF: Prod

redef fun accept_pretty_printer(v: PrettyPrinterVisitor)

redef fun collect_length: Int

redef fun replace_with(n: ANode)

redef fun was_inline: Bool

Summary

All properties

!=

==

CLASS

SELF

_first_location

_first_token

_force_block

_force_inline

_is_broken

_last_token

_location

_n_annotations

_parent

accept_ast_validation

accept_auto_super_init

accept_flow_visitor

accept_forward_analysis

accept_literal