class CmdEntityCode

nitc :: CmdEntityCode

Cmd that finds the source code related to an mentity

Introduced properties

private var _format: String

nitc :: CmdEntityCode :: _format

private var _modelbuilder: ModelBuilder

nitc :: CmdEntityCode :: _modelbuilder

ModelBuilder used to get AST nodes from entities
init defaultinit(model: Model, modelbuilder: ModelBuilder, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, format: nullable String)

nitc :: CmdEntityCode :: defaultinit

fun modelbuilder: ModelBuilder

nitc :: CmdEntityCode :: modelbuilder

ModelBuilder used to get AST nodes from entities
protected fun modelbuilder=(modelbuilder: ModelBuilder)

nitc :: CmdEntityCode :: modelbuilder=

ModelBuilder used to get AST nodes from entities

Redefined properties

redef type SELF: CmdEntityCode

nitc $ CmdEntityCode :: SELF

Type of this instance, automatically specialized in every class
redef fun execute(no_color: nullable Bool)

nitc :: term $ CmdEntityCode :: execute

redef fun format: String

nitc :: term $ CmdEntityCode :: format

Rendering format
redef fun format=(format: nullable String)

nitc :: term $ CmdEntityCode :: format=

Rendering format
redef fun http_init(req: HttpRequest): CmdMessage

nitc :: commands_http $ CmdEntityCode :: http_init

FIXME avoid linearization conflict
redef fun init_command: CmdMessage

nitc $ CmdEntityCode :: init_command

Same as CmdEntity::init_mentity

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
private var _filter: nullable ModelFilter

nitc :: DocCommand :: _filter

ModelFilter to apply if any
private var _format: String

nitc :: CmdEntityCode :: _format

private var _format: String

nitc :: CmdCode :: _format

Rendering format
private var _mentity: nullable MEntity

nitc :: CmdEntity :: _mentity

MEntity this command is about
private var _mentity_name: nullable String

nitc :: CmdEntity :: _mentity_name

Name of the mentity this command is about
private var _model: Model

nitc :: DocCommand :: _model

Model to retrieve data for
private var _modelbuilder: ModelBuilder

nitc :: CmdEntityCode :: _modelbuilder

ModelBuilder used to get AST nodes from entities
private var _node: nullable ANode

nitc :: CmdCode :: _node

AST node to display code from
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.
fun cmd_filter: ModelFilter

nitc :: DocCommand :: cmd_filter

Return a new filter for that command execution.
init defaultinit(model: Model, filter: nullable ModelFilter, node: nullable ANode, format: nullable String)

nitc :: CmdCode :: defaultinit

init defaultinit(model: Model, modelbuilder: ModelBuilder, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String, format: nullable String)

nitc :: CmdEntityCode :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, mentity: nullable MEntity, mentity_name: nullable String)

nitc :: CmdEntity :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter)

nitc :: DocCommand :: defaultinit

abstract fun execute(no_color: nullable Bool)

nitc :: DocCommand :: execute

fun filter: nullable ModelFilter

nitc :: DocCommand :: filter

ModelFilter to apply if any
protected fun filter=(filter: nullable ModelFilter)

nitc :: DocCommand :: filter=

ModelFilter to apply if any
fun format: String

nitc :: CmdCode :: format

Rendering format
fun format=(format: nullable String)

nitc :: CmdCode :: format=

Rendering format
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.
fun http_init(req: HttpRequest): CmdMessage

nitc :: DocCommand :: http_init

Init the command from an HTTPRequest
init init

core :: Object :: init

fun init_command: CmdMessage

nitc :: DocCommand :: init_command

Initialize the command
fun init_mentity: CmdMessage

nitc :: CmdEntity :: init_mentity

Initialize the command mentity.
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.
fun mentity: nullable MEntity

nitc :: CmdEntity :: mentity

MEntity this command is about
fun mentity=(mentity: nullable MEntity)

nitc :: CmdEntity :: mentity=

MEntity this command is about
fun mentity_name: nullable String

nitc :: CmdEntity :: mentity_name

Name of the mentity this command is about
fun mentity_name=(mentity_name: nullable String)

nitc :: CmdEntity :: mentity_name=

Name of the mentity this command is about
fun model: Model

nitc :: DocCommand :: model

Model to retrieve data for
protected fun model=(model: Model)

nitc :: DocCommand :: model=

Model to retrieve data for
fun modelbuilder: ModelBuilder

nitc :: CmdEntityCode :: modelbuilder

ModelBuilder used to get AST nodes from entities
protected fun modelbuilder=(modelbuilder: ModelBuilder)

nitc :: CmdEntityCode :: modelbuilder=

ModelBuilder used to get AST nodes from entities
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
fun node: nullable ANode

nitc :: CmdCode :: node

AST node to display code from
fun node=(node: nullable ANode)

nitc :: CmdCode :: node=

AST node to display code from
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).
fun parser_init(arg: String, options: CmdOptions): CmdMessage

nitc :: DocCommand :: parser_init

Initialize the command from the CommandParser data
fun render_code(node: ANode): Writable

nitc :: CmdCode :: render_code

Render node depending on the selected format
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_html: Writable

nitc :: DocCommand :: to_html

Render results as a HTML string
abstract fun to_json: nullable Serializable

nitc :: DocCommand :: to_json

Return a JSON Serializable representation of self results
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_md: Writable

nitc :: DocCommand :: to_md

Render results as a Markdown string
fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram nitc::CmdEntityCode CmdEntityCode nitc::CmdEntity CmdEntity nitc::CmdEntityCode->nitc::CmdEntity nitc::CmdCode CmdCode nitc::CmdEntityCode->nitc::CmdCode nitc::DocCommand DocCommand nitc::CmdEntity->nitc::DocCommand nitc::CmdCode->nitc::DocCommand ...nitc::DocCommand ... ...nitc::DocCommand->nitc::DocCommand

Ancestors

abstract class DocCommand

nitc :: DocCommand

Documentation command
interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class CmdCode

nitc :: CmdCode

Abstract command that returns source-code pieces
class CmdEntity

nitc :: CmdEntity

A command about a MEntity

Class definitions

nitc $ CmdEntityCode 
# Cmd that finds the source code related to an `mentity`
class CmdEntityCode
	super CmdEntity
	super CmdCode

	autoinit(model, modelbuilder, filter, mentity, mentity_name, format)

	# ModelBuilder used to get AST nodes from entities
	var modelbuilder: ModelBuilder

	# Same as `CmdEntity::init_mentity`
	#
	# Plus `WarningNoCode` if no code/AST node is found for `mentity`.
	redef fun init_command do
		if node != null then return new CmdSuccess

		var res = super
		if not res isa CmdSuccess then return res
		var mentity = self.mentity.as(not null)

		if mentity isa MClass then mentity = mentity.intro
		if mentity isa MProperty then mentity = mentity.intro
		node = modelbuilder.mentity2node(mentity)
		if node == null then return new WarningNoCode(mentity)
		return res
	end
end
src/doc/commands/commands_model.nit:443,1--469,3

nitc :: commands_http $ CmdEntityCode 
redef class CmdEntityCode
	# FIXME avoid linearization conflict
	redef fun http_init(req) do
		var name = req.param("id")
		if name != null then name = name.from_percent_encoding
		mentity_name = name

		var opt_format = req.string_arg("format")
		if opt_format != null then format = opt_format
		return init_command
	end
end
src/doc/commands/commands_http.nit:175,1--186,3

nitc :: term $ CmdEntityCode 
redef class CmdEntityCode

	redef var format = "ansi" is optional

	redef fun execute(no_color) do
		var mentity = self.mentity
		if mentity == null then return

		var title = "Code for `{mentity.cs_full_name(no_color)}`:"
		if no_color == null or not no_color then
			print title.bold
		else
			print title
		end
		var node = self.node
		if (no_color == null or not no_color) and node != null then
			var ansi = render_code(node)
			print "~~~"
			print ansi.write_to_string
			print "~~~"
		else
			printn mentity.cs_source_code
		end
	end
end
src/doc/term/term.nit:211,1--235,3
Nit tools. Version .