Cmd that finds the ini file related to an `mentity`

Introduced properties

private var _ini: nullable IniFile

nitc :: CmdIni :: _ini

Ini file

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

nitc :: CmdIni :: defaultinit

fun ini: nullable IniFile

nitc :: CmdIni :: ini

Ini file

protected fun ini=(ini: nullable IniFile)

nitc :: CmdIni :: ini=

Ini file

fun print_ini(title: String, data: nullable String, no_color: nullable Bool)

nitc :: CmdIni :: print_ini

Print ini data

Redefined properties

redef type SELF: CmdIni

nitc $ CmdIni :: SELF

Type of this instance, automatically specialized in every class

redef fun init_command: CmdMessage

nitc $ CmdIni :: init_command

Initialize the command

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 _ini: nullable IniFile

nitc :: CmdIni :: _ini

Ini file

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.

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

nitc :: DocCommand :: defaultinit

init defaultinit

core :: Object :: 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, mentity: nullable MEntity, mentity_name: nullable String)

nitc :: CmdIni :: 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 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

fun ini: nullable IniFile

nitc :: CmdIni :: ini

Ini file

protected fun ini=(ini: nullable IniFile)

nitc :: CmdIni :: ini=

Ini file

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

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 print_ini(title: String, data: nullable String, no_color: nullable Bool)

nitc :: CmdIni :: print_ini

Print ini 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.

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.

Ancestors

abstract class DocCommand

nitc :: DocCommand

Documentation command

interface Object

The root of the class hierarchy.

Parents

class CmdEntity

nitc :: CmdEntity

A command about a MEntity

Children

class CmdIniContributors

nitc :: CmdIniContributors

Cmd that finds the contributors list of an mentity

class CmdIniDescription

nitc :: CmdIniDescription

Cmd that finds the ini description related to an mentity

class CmdIniGitUrl

nitc :: CmdIniGitUrl

Cmd that finds the clone url related to an mentity

class CmdIniIssuesUrl

nitc :: CmdIniIssuesUrl

Cmd that finds the issues link related to an mentity

class CmdIniLicense

nitc :: CmdIniLicense

Cmd that finds the license related to an mentity

class CmdIniMaintainer

nitc :: CmdIniMaintainer

Cmd that finds the maintainer name of an mentity

Descendants

class CmdIniCloneCommand

nitc :: CmdIniCloneCommand

Cmd that finds the git clone command related to an mentity

Class definitions

nitc $ CmdIni

# Cmd that finds the ini file related to an `mentity`
abstract class CmdIni
	super CmdEntity

	# Ini file
	var ini: nullable IniFile = null

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

		if not mentity isa MPackage then return new WarningNoIni(mentity)

		var ini = mentity.ini
		if ini == null then return new WarningNoIni(mentity)

		self.ini = ini

		return res
	end
end

src/doc/commands/commands_ini.nit:19,1--40,3

nitc :: term $ CmdIni

redef class CmdIni
	# Print ini data
	fun print_ini(title: String, data: nullable String, no_color: nullable Bool) do
		if data == null then return
		if no_color == null or not no_color then
			print title.bold
		else
			print title
		end
		print ""
		print data
	end
end

src/doc/term/term.nit:353,1--365,3