A position into a input stream

Used to give position to tokens

Introduced properties

protected fun col_end=(col_end: Int)

nitcc_runtime :: Position :: col_end=

protected fun col_start=(col_start: Int)

nitcc_runtime :: Position :: col_start=

init defaultinit(pos_start: Int, pos_end: Int, line_start: Int, line_end: Int, col_start: Int, col_end: Int)

nitcc_runtime :: Position :: defaultinit

fun extract(source: String): String

nitcc_runtime :: Position :: extract

Extract the content from the given source
protected fun line_end=(line_end: Int)

nitcc_runtime :: Position :: line_end=

protected fun line_start=(line_start: Int)

nitcc_runtime :: Position :: line_start=

protected fun pos_end=(pos_end: Int)

nitcc_runtime :: Position :: pos_end=

protected fun pos_start=(pos_start: Int)

nitcc_runtime :: Position :: pos_start=

fun underline(source: Text): String

nitcc_runtime :: Position :: underline

Get the lines covered by self and underline the target columns.

Redefined properties

redef type SELF: Position

nitcc_runtime $ Position :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

nitcc_runtime $ Position :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

nitcc_runtime $ Position :: from_deserializer

Create an instance of this class from the deserializer
redef fun to_s: String

nitcc_runtime $ Position :: to_s

User readable representation of self.

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
protected fun col_end=(col_end: Int)

nitcc_runtime :: Position :: col_end=

protected fun col_start=(col_start: Int)

nitcc_runtime :: Position :: col_start=

fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
init defaultinit(pos_start: Int, pos_end: Int, line_start: Int, line_end: Int, col_start: Int, col_end: Int)

nitcc_runtime :: Position :: defaultinit

fun extract(source: String): String

nitcc_runtime :: Position :: extract

Extract the content from the given source
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
protected fun line_end=(line_end: Int)

nitcc_runtime :: Position :: line_end=

protected fun line_start=(line_start: Int)

nitcc_runtime :: Position :: line_start=

protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
protected fun pos_end=(pos_end: Int)

nitcc_runtime :: Position :: pos_end=

protected fun pos_start=(pos_start: Int)

nitcc_runtime :: Position :: pos_start=

fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun underline(source: Text): String

nitcc_runtime :: Position :: underline

Get the lines covered by self and underline the target columns.
package_diagram nitcc_runtime::Position Position serialization::Serializable Serializable nitcc_runtime::Position->serialization::Serializable core::Object Object serialization::Serializable->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Class definitions

nitcc_runtime $ Position
# A position into a input stream
# Used to give position to tokens
class Position
	serialize

	var pos_start: Int
	var pos_end: Int
	var line_start: Int
	var line_end: Int
	var col_start: Int
	var col_end: Int

	redef fun to_s do return "{line_start}:{col_start}-{line_end}:{col_end}"

	# Extract the content from the given source
	fun extract(source: String): String
	do
		return source.substring(pos_start, pos_end-pos_start+1)
	end

	# Get the lines covered by `self` and underline the target columns.
	#
	# This is useful for pretty printing errors or debug the output
	#
	# ~~~
	# var src = "var Foo = new Array[Int]"
	# var pos = new Position(0,0, 1, 1, 5, 8)
	#
	# assert pos.underline(src) == """
	# var Foo = new Array[Int]
	#     ^^^"""
	# ~~~
	fun underline(source: Text): String
	do
		var res = new FlatBuffer

		# All the concerned lines
		var lines = source.split("\n")
		for line in [line_start..line_end] do
			res.append lines[line-1]
			res.append "\n"
		end

		# Cover all columns, no matter their lines
		var col_start = col_start.min(col_end)
		var col_end = self.col_start.max(col_end)

		# "           ^^^^"
		var ptr = " "*(col_start-1).max(0) + "^"*(col_end-col_start)
		res.append ptr

		return res.to_s
	end
end
lib/nitcc_runtime/nitcc_runtime.nit:305,1--358,3