IPM
Main Class Reference
Inheritance diagram for Main:
Inheritance graph

Static Public Member Functions

_.Library.String DrawColumn (desc)
 draw description
 
 GetDefaultCommandRegistry ()
 Get Default Command of Registry. More...
 
_.Library.Status GetListModule (ns, Mod, OnlyName)
 Get module list in currently namespace.
 
 GetListNamespace (list, _.Library.String pSearch)
 Get list Namespace, example do ##class(IPM.Main).GetListNamespace(.ns)
 
 GetMapInfo (pIsMappedFrom, pIsMappedTo)
 Get the mapping relationship for IPM package. More...
 
 GetVersion (ModuleName, out, list)
 @API.Method More...
 
 GetVersionModule (name, namespace)
 Get Version Module.
 
_.Library.Boolean IsAvailable (_.Library.String pModuleName, _.Library.String pNamespace, pArgs)
 @API.Method
 
 PrintTree (pTree)
 Prints a tree with unicode box art. More...
 
 RunDependencyAnalyzer (pCommandInfo)
 Run Dependency Analyzer for the given module.
 
_.Library.Status Shell (_.Library.String pCommand, _.Library.Boolean pTerminateOnError, _.Library.Boolean pHaltOnComplete)
 @API.Method
 
 ShellScript (_.Library.String pCommand, _.Library.String pOutputLogFile, _.Library.Boolean pAppendToLog)
 Runs package manager commands in a way that is friendly to the OS-level shell. More...
 
- Static Public Member Functions inherited from CLI
 DrawBorder (_.Library.List pLineList, _.Library.Integer pTextFormat)
 Draw a border around a list of strings. More...
 
_.Library.String FormatName (_.Library.String pName)
 Format the given name such that all punctuation characters are remove and. More...
 
 ParseJsonToCommand (_.Library.DynamicObject pJson)
 Read JSON and construct a command matching the schema in the Commands XData blocks. More...
 

Static Private Member Functions

 __AddIPMMappedNamespaces (list)
 Argument list is a multidimensional array where list contains the a numeric value n, indicating the length of the list. More...
 

Additional Inherited Members

- Static Public Attributes inherited from CLI
 CommandsAccessorIncludeFilename = None
 Name of include file that will contain accessor macros for modifiers. More...
 
- Static Public Attributes inherited from Commands
 CommandsAccessorIncludeFilename = None
 Name of include file that will contain accessor macros for modifiers. More...
 

Member Function Documentation

◆ __AddIPMMappedNamespaces()

__AddIPMMappedNamespaces (   list)
staticprivate

Argument list is a multidimensional array where list contains the a numeric value n, indicating the length of the list.

Each subnode list(i) where 1 <= i <= n contains a $ListBuild of a single namespace Each subnote list(i,"modules") contains the number of modules in the namespace For 1 <= j <= list(i,"modules"), each subnode list(i,"modules",j) contains a $ListBuild of the module name, version, external name, and whether the module is installed in developer mode Additional nodes are also accepted, although they are not used in this method For example: list=1 list(1)=$lb("USER") list(1,"modules")=2 list(1,"modules",1)=$lb("zpm","0.9.0-SNAPSHOT","Package Management System",1) list(1,"modules",2)=$lb("zpm-registry","1.3.2","ZPM Registry",0) list(1,"modules","width")=12 list("ns")="*" list("width")=4

◆ GetDefaultCommandRegistry()

GetDefaultCommandRegistry ( )
static

Get Default Command of Registry.

example d ##class(IPM.Main).GetDefaultCommandRegistry()

◆ GetMapInfo()

GetMapInfo (   pIsMappedFrom,
  pIsMappedTo 
)
static

Get the mapping relationship for IPM package.

Format:

  • pIsMappedFrom(destinationNamespace) = sourceNamespace
  • pIsMappedTo(sourceNamespace, destinationNamespace) = ""

◆ GetVersion()

GetVersion (   ModuleName,
  out,
  list 
)
static

@API.Method

Get Version modules and current registry example do ##class(IPM.Main).GetVersion("zpm,zpm-registry",.out,.list)

◆ PrintTree()

PrintTree (   pTree)
static

Prints a tree with unicode box art.

Tree representation should be: pTree(<node no.>) = $listbuild(

, <first child node no.>, <next sibling node no.>) With the first node in node #1 (no root - it can have siblings), and the subscripts are sequential according to pre-order (which is how the tree will be displayed, one node per line).

◆ ShellScript()

ShellScript ( _.Library.String  pCommand,
_.Library.String  pOutputLogFile,
_.Library.Boolean  pAppendToLog 
)
static

Runs package manager commands in a way that is friendly to the OS-level shell.

Creates pOutputLogFile if it does not exist. If it does, and pAppendToLog is true, appends to it; otherwise, deletes the file before outputting to it.