Cmd that finds the nitc command related to an mentity

Introduced properties

private var _command: nullable String

nitc :: CmdMainCompile :: _command

private var _file: nullable SourceFile

nitc :: CmdMainCompile :: _file

fun command: nullable String

nitc :: CmdMainCompile :: command

protected fun command=(command: nullable String)

nitc :: CmdMainCompile :: command=

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

nitc :: CmdMainCompile :: defaultinit

fun file: nullable SourceFile

nitc :: CmdMainCompile :: file

protected fun file=(file: nullable SourceFile)

nitc :: CmdMainCompile :: file=

private fun mmodule_main(mmodule: MModule): nullable SourceFile

nitc :: CmdMainCompile :: mmodule_main

Does mmodule has a main method?
private fun test_path(file: nullable SourceFile): nullable String

nitc :: CmdMainCompile :: test_path

Return the sourcefile path

Redefined properties

redef type SELF: CmdMainCompile

nitc $ CmdMainCompile :: SELF

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

nitc :: term $ CmdMainCompile :: execute

redef fun init_command: CmdMessage

nitc $ CmdMainCompile :: init_command

Initialize the command
redef fun to_html: Writable

nitc :: html_commands $ CmdMainCompile :: to_html

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

nitc :: json_commands $ CmdMainCompile :: to_json

Return a JSON Serializable representation of self results
redef fun to_md: Writable

nitc :: md_commands $ CmdMainCompile :: to_md

Render results as a Markdown string

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 _command: nullable String

nitc :: CmdMainCompile :: _command

private var _file: nullable SourceFile

nitc :: CmdMainCompile :: _file

private var _filter: nullable ModelFilter

nitc :: DocCommand :: _filter

ModelFilter to apply if any
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
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.
fun command: nullable String

nitc :: CmdMainCompile :: command

protected fun command=(command: nullable String)

nitc :: CmdMainCompile :: command=

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

nitc :: CmdMainCompile :: 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 file: nullable SourceFile

nitc :: CmdMainCompile :: file

protected fun file=(file: nullable SourceFile)

nitc :: CmdMainCompile :: file=

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 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
private fun mmodule_main(mmodule: MModule): nullable SourceFile

nitc :: CmdMainCompile :: mmodule_main

Does mmodule has a main method?
fun model: Model

nitc :: DocCommand :: model

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

nitc :: DocCommand :: model=

Model to retrieve data for
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
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 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.
private fun test_path(file: nullable SourceFile): nullable String

nitc :: CmdMainCompile :: test_path

Return the sourcefile path
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::CmdMainCompile CmdMainCompile nitc::CmdEntity CmdEntity nitc::CmdMainCompile->nitc::CmdEntity nitc::DocCommand DocCommand nitc::CmdEntity->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

class CmdEntity

nitc :: CmdEntity

A command about a MEntity

Class definitions

nitc $ CmdMainCompile
# Cmd that finds the nitc command related to an `mentity`
class CmdMainCompile
	super CmdEntity

	var file: nullable SourceFile = null

	var command: nullable String is lazy do
		var path = test_path(file)
		if path == null then return null
		return "nitc {path}"
	end

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

		if mentity isa MModule then
			file = mmodule_main(mentity)
			if file == null then return new WarningNoMain(mentity)
		else
			return new WarningNoMain(mentity)
		end
		return res
	end

	# Does `mmodule` has a `main` method?
	private fun mmodule_main(mmodule: MModule): nullable SourceFile do
		for mclassdef in mmodule.mclassdefs do
			if mclassdef.name != "Sys" then continue
			for mpropdef in mclassdef.mpropdefs do
				if mpropdef.name == "main" then return mmodule.location.file
			end
		end
		return null
	end

	# Return the sourcefile path
	#
	# This method exists for the only purpose to be redefined by nitunit tests
	# to avoid path diffs.
	private fun test_path(file: nullable SourceFile): nullable String do
		if file == null then return null
		var base_path = mentity.as(MModule).mpackage.as(not null).location.file.as(not null).filename
		return file.filename.replace(base_path, "")
	end
end
src/doc/commands/commands_main.nit:73,1--119,3

nitc :: md_commands $ CmdMainCompile
redef class CmdMainCompile
	redef fun to_md do
		var command = self.command
		if command == null then return ""

		var tpl = new Template
		tpl.addn "~~~sh"
		tpl.addn command
		tpl.addn "~~~"
		return tpl.write_to_string
	end
end
src/doc/templates/md_commands.nit:291,1--302,3

nitc :: json_commands $ CmdMainCompile
redef class CmdMainCompile
	redef fun to_json do
		var obj = new JsonObject
		obj["command"] = command
		return obj
	end
end
src/doc/templates/json_commands.nit:264,1--270,3

nitc :: term $ CmdMainCompile
redef class CmdMainCompile
	redef fun execute(no_color) do
		var mentity = self.mentity.as(not null).full_name
		if no_color == null or not no_color then mentity = mentity.blue.bold
		var title = "Compiling `{mentity}`:"

		if no_color == null or not no_color then
			print title.bold
		else
			print title
		end

		print ""
		var command = self.command
		if command != null then print command
	end
end
src/doc/term/term.nit:466,1--482,3

nitc :: html_commands $ CmdMainCompile
redef class CmdMainCompile
	redef fun to_html do
		var command = self.command
		if command == null then return ""

		return "<pre>{command}</pre>"
	end
end
src/doc/templates/html_commands.nit:311,1--318,3