Class: Tag (in Tools)

• Inheritance
• Description
• Class protocol
  • accessing
  • instance creation
• Instance protocol
  • accessing
  • instance creation
  • list interface
  • printing & storing
  • queries
  • tag searching
  • testing
• Private classes

Inheritance:

   Object
   |
   +--Tools::Tag
      |
      +--Tools::Tag::TCaseLabel
      |
      +--Tools::Tag::TClass
      |
      +--Tools::Tag::TDefinition
      |
      +--Tools::Tag::TDocumentation
      |
      +--Tools::Tag::TElement
      |
      +--Tools::Tag::TEnum
      |
      +--Tools::Tag::TEnumMember
      |
      +--Tools::Tag::TField
      |
      +--Tools::Tag::TFunction
      |
      +--Tools::Tag::TInclude
      |
      +--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.23 date: 2023/02/22 18:00:12

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

copyright
COPYRIGHT (c) 2002 by eXept Software AG 
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 typeIdentifier

 label: aLabel pattern: aPattern

 label: aLabel pattern: aPattern type: tagTypeString

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

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

Instance protocol:

 fileName

returns the fileName (project tags only)

 fileName: aFilename

set the fileName (project tags only)

 label

 label: aString

 lineNumber

returns the lineNumber computed at beginning

 lineNumber: aNumber

set the lineNumber computed at beginning

 pattern

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

 typeIdentifierInList

 typeString

 label: aLabel pattern: aPattern lineNumber: aLineNumer className: cName

 explainString

 printString

returns the label used in a list

 printStringWithoutClass

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

 shortInfoString

pathName

 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.

 widthOn: aGC

(comment from inherited method)
return the width of the receiver, if it is to be displayed on aGC

 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

 isClassTag

return true, if this is a java class tag

 isDocumentationTag

return true, if this is a doc tag

 isEnumMemberTag

 isEnumTag

 isFieldTag

return true, if this is a java field tag

 isFunctionOrMethodTag

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

 isFunctionTag

return true, if this is a function tag

 isIncludeTag

return true, if this is an include/load/import/require tag

 isInterfaceTag

return true, if this is a java interface tag

 isLabelTag

return true, if this is a label tag

 isLispConstantTag

return true, if this is a lisp constant tag

 isLispEvalTag

return true, if this is a lisp eval tag

 isLispMacroTag

return true, if this is a lisp macro tag

 isMacroTag

return true, if this is a define macro tag

 isMakeTargetTag

return true, if this is a make-target tag

 isMemberTag

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

 isMethodTag

return true, if this is a java method tag

 isPackageTag

return true, if this is a java package tag

 isPrologClause

return true, if this is a prolog clause tag

 isStructOrUnionTag

return true, if this is a union tag

 isStructTag

return true, if this is a struct tag

 isTypeTag

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

 isTypedefTag

return true, if this is a typedef tag

 isUnionTag

return true, if this is a union tag

 isVariableTag

return true, if this is a variable tag

Private classes:

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