eXept Software AG Logo

Smalltalk/X Webserver

Documentation of class 'Tools::Tag':

Home

Documentation
www.exept.de
Everywhere
for:
[back]

Class: Tag (in Tools)


Inheritance:

   Object
   |
   +--Tools::Tag
      |
      +--Tools::Tag::TCaseLabel
      |
      +--Tools::Tag::TClass
      |
      +--Tools::Tag::TDocumentation
      |
      +--Tools::Tag::TElement
      |
      +--Tools::Tag::TEnum
      |
      +--Tools::Tag::TEnumMember
      |
      +--Tools::Tag::TField
      |
      +--Tools::Tag::TFunction
      |
      +--Tools::Tag::TInterface
      |
      +--Tools::Tag::TLabel
      |
      +--Tools::Tag::TLispConstant
      |
      +--Tools::Tag::TLispEval
      |
      +--Tools::Tag::TLispMacro
      |
      +--Tools::Tag::TMacro
      |
      +--Tools::Tag::TMakeRule
      |
      +--Tools::Tag::TMakeTarget
      |
      +--Tools::Tag::TMember
      |
      +--Tools::Tag::TMethod
      |
      +--Tools::Tag::TPackage
      |
      +--Tools::Tag::TPrologClause
      |
      +--Tools::Tag::TStruct
      |
      +--Tools::Tag::TTypedef
      |
      +--Tools::Tag::TUnion
      |
      +--Tools::Tag::TVariable

Package:
stx:libtool
Category:
Interface-Tools-File-Tags
Version:
rev: 1.18 date: 2019/07/31 15:12:29
user: cg
file: Tools__Tag.st directory: libtool
module: stx stc-classLibrary: libtool

Description:


keeps the info for a single tag (for the fileBrowser, for example);
either read from an external tool (ctags) or generated internally


Class protocol:

accessing
o  typeIdentifier

instance creation
o  label: aLabel pattern: aPattern

o  label: aLabel pattern: aPattern type: tagTypeString

o  label: aLabel pattern: aPattern type: tagTypeString lineNumber: aLineNumer

o  label: aLabel pattern: aPattern type: tagTypeString lineNumber: aLineNumer className: cName


Instance protocol:

accessing
o  fileName
returns the fileName (project tags only)

o  fileName: aFilename
set the fileName (project tags only)

o  label

o  lineNumber
returns the lineNumber computed at beginning

o  lineNumber: aNumber
set the lineNumber computed at beginning

o  pattern
returns the pattern string, used to detect the line into a
contents

o  typeIdentifierInList

o  typeString

instance creation
o  label: aLabel pattern: aPattern lineNumber: aLineNumer className: cName

list interface
o  explainString

o  printString
returns the label used in a list

o  printStringWithoutClass
returns a short label (used in a list when all labels are for the same class)

o  shortInfoString
pathName

printing & storing
o  printOn: aStream
(comment from inherited method)
append a user printed representation of the receiver to aStream.
The format is suitable for a human - not meant to be read back.

The default here is to output the receiver's class name.
BUT: this method is heavily redefined for objects which
can print prettier.

queries
o  widthOn: aGC

tag searching
o  lineNumberIn: someStringCollectionOrFilename
search the tag and return the line nr or 0, if not found.
search either in the collection of lines or the file's contents.
This is called with the contents for small files,
but with the fileName for huge ones

testing
o  isClassTag
return true, if this is a java class tag

o  isDocumentationTag
return true, if this is a doc tag

o  isEnumMemberTag

o  isEnumTag

o  isFieldTag
return true, if this is a java field tag

o  isFunctionOrMethodTag
return true, if this is a function or a method tag

o  isFunctionTag
return true, if this is a function tag

o  isInterfaceTag
return true, if this is a java interface tag

o  isLabelTag
return true, if this is a label tag

o  isLispConstantTag
return true, if this is a lisp constant tag

o  isLispEvalTag
return true, if this is a lisp eval tag

o  isLispMacroTag
return true, if this is a lisp macro tag

o  isMacroTag
return true, if this is a define macro tag

o  isMakeTargetTag
return true, if this is a make-target tag

o  isMemberTag
return true, if this is a struct/union member tag

o  isMethodTag
return true, if this is a java method tag

o  isPackageTag
return true, if this is a java package tag

o  isPrologClause
return true, if this is a prolog clause tag

o  isStructOrUnionTag
return true, if this is a union tag

o  isStructTag
return true, if this is a struct tag

o  isTypeTag
return true, if this is any type tag (typedef, struct, union, enum, ...)

o  isTypedefTag
return true, if this is a typedef tag

o  isUnionTag
return true, if this is a union tag

o  isVariableTag
return true, if this is a variable tag


Private classes:

    TAnchorElement
    TCaseLabel
    TClass
    TDocumentation
    TElement
    TEnum
    TEnumMember
    TField
    TFormElement
    TFunction
    THeaderElement
    TInterface
    TLabel
    TLispConstant
    TLispEval
    TLispMacro
    TMacro
    TMakeRule
    TMakeTarget
    TMember
    TMethod
    TPackage
    TPrologClause
    TStruct
    TTypedef
    TUnion
    TVariable


ST/X 7.2.0.0; WebServer 1.670 at bd0aa1f87cdd.unknown:8081; Fri, 16 Apr 2021 11:31:27 GMT