Differences

This shows you the differences between two versions of the page.

--- ch2_3_pack_sym [2021/04/25 02:12] – admin
+++ ch2_3_pack_sym [2025/01/29 08:35] (current) – admin
@@ Line 26: / Line 26: @@
 ''FIND-SYMBOL''
-Finds symbol by name in a package. Expects one string argument - the symbol name - and optional argument which is a package designator. Package designator can be string or symbol or package object itself. If the package name is not supplied, dynamic current package is used. Returns the symbol if it is found, otherwise ''NIL''. If it is found, also prints the symbol's relation to the package. Note that in Common LISP, this function returns two values, the second is a keyword which characterizes the relation. LabLISP function prints the same keyword, but it is not output of the function, because LabLisp does not support multiple values yet.
+Finds symbol by name in a package. Expects one string argument - the symbol name - and optional argument which is a package designator. Package designator can be string or symbol or package object itself. If the package name is not supplied, dynamic current package is used. Returns the symbol if it is found, otherwise ''NIL''. If it is found, also prints the symbol's relation to the package. As in Common LISP, this function returns two values, the second is a keyword which characterizes the relation.
 <code lisp>
 >(find-symbol "PI")            ; USER package will be searched
-:INHERITED                     ; it is inherited from base package LABLISP
 PI
+:INHERITED                     ; it is inherited from base package LABLISP
 >(find-symbol "PI" "LABLISP")  ; now we search in LABLISP package
-:EXTERNAL                      ; there the symbol is external
 PI
+:EXTERNAL                      ; there the symbol is external
 </code>
@@ Line 65: / Line 65: @@
 ''INTERN''
-Like ''FIND-SYMBOL'', looks up symbol by name in a package, and returns it the same way as ''FIND-SYMBOL''. But  when it is not present, it makes a new symbol with the package as owner. Expects one string argument - the symbol name - and optional argument which is a package designator.
+Like ''FIND-SYMBOL'', looks up symbol by name in a package, and returns it the same way as ''FIND-SYMBOL''. But  when it is not present, it makes a new symbol with the package as owner. Expects one string argument - the symbol name - and optional argument which is a package designator. Returns two values, like ''FIND-SYMBOL''.
 <code lisp>
 >(intern "BLA")       ; without the package designator give, will use USER package
-NIL                   ; NIL means that it is a new symbol
 BLA
+NIL                   ; NIL means that it is a new symbol
 >(intern "BLA")       ; we can call it again, for USER package
-:INTERNAL             ; now it is already present as internal symbol
 BLA
+:INTERNAL             ; now it is already present as internal symbol
 </code>
@@ Line 120: / Line 120: @@
 >(in-package "P1")    ; assuming we made the P1 package in previous example
 #<The P1 package>
+</code>
+''LIST-ALL-PACKAGES''
+No arguments, returns list of all packages in the environment.
+<code lisp>
+>(list-all-packages)
+(#<The USER package> #<The LABLISP package> #<The KEYWORD package>)  ; vanilla lablisp environment
 </code>
 ''USE-PACKAGE''
+Adds one or more packages to be used by a target package. Exported symbols from the source package(s), will be accessible through the target package. First argument is package designator or list of package designators. Second argument is optional target package designator, default is the dynamic current package.((dynamic current package means package bound to *PACKAGE* symbol in dynamic environment))
+Beware of name conflicts!
+<code lisp>
+>(use-package "P1" "P2")     ; use P1 in P2
+T
+</code>
 ''UNUSE-PACKAGE''
+Removes one or more packages from a target package's use list. First argument is package designator or list of package designators to be removed. Second argument is optional target package designator, default is the dynamic current package.
+<code lisp>
+>(unuse-package "P1" "P2")   ; stop using P1 in P2
+T
+</code>
+''PACKAGE-USE-LIST''
+Lists all packages that are used by a target package. Single argument is target package designator. The argument is optional, defaults to the dynamic current package.
+Following two examples assume the situation after the ''USE-PACKAGE'' example above.
+<code lisp>
+>(package-use-list "P2")
+(#<The P1 package> #<The LABLISP package>)    ; any new package has access to base lablisp
+</code>
+''PACKAGE-USED-BY-LIST''
+Lists all packages that use a target package. Single argument is target package designator. The argument is optional, defaults to the dynamic current package.
+<code lisp>
+>(package-used-by-list "P1")
+(#<The P2 package>)             ; package P1 is used by P2
+</code>
 ''IMPORT''
-''EXPORT''
+Symbol becomes internal of the target package, if the symbol was //homeless//, the target package becomes symbol's home package. First argument is symbol or list of symbols. Second argument is optional target package designator, default is the dynamic current package.
+Beware of name conflicts!
 ''UNINTERN''
-''UNEXPORT''
+Removes symbol from package, so it is no longer accessible as internal or external symbol. If the package is the symbol's home pacakge, then the symbol becomes //homeless//. First argument is symbol or list of symbols. Second argument is optional target package designator, default is the dynamic current package.
-''LIST-ALL-PACKAGES''
+The name ''UNINTERN'' is slightly misleading, the command is mostly used to revert ''IMPORT'', but it revets ''INTERN'' as well.
-''PACKAGE-USE-LIST''
+''EXPORT''
-''PACKAGE-USED-BY-LIST''
+Makes inherited or internal symbol to be external in given package. If the symbol is inherited, ''EXPORT'' will first ''IMPORT'' the symbol, them move from internal list to external list. First argument is symbol or list of symbols. Second argument is optional target package designator, default is the dynamic current package.
+Beware of name conflicts!
+''UNEXPORT''
+Undoes ''EXPORT'', moves symbol from external list to internal list. First argument is symbol or list of symbols. Second argument is optional target package designator, default is the dynamic current package.
 ''PACKAGE-INTERNAL-SYMBOLS''
+Lists all internal symbols of a target package. Single argument is target package designator. The argument is optional, defaults to the dynamic current package.
 ''PACKAGE-EXTERNAL-SYMBOLS''
+Lists all external symbols of a target package. Single argument is target package designator. The argument is optional, defaults to the dynamic current package.