"{ Encoding: utf8 }"

"

 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.

"

"{ Package: 'stx:libtool' }"

"{ NameSpace: Tools }"

Object subclass:#Tag

	instanceVariableNames:'width label pattern lineNumber fileName className'

	classVariableNames:''

	poolDictionaries:''

	category:'Interface-Tools-File-Tags'

!

Tag subclass:#TElement

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TCaseLabel

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TClass

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TDocumentation

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag::TElement subclass:#TAnchorElement

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TEnum

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TEnumMember

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TField

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag::TElement subclass:#TFormElement

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TFunction

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag::TElement subclass:#THeaderElement

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TInterface

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TLabel

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TLispConstant

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TLispEval

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TLispMacro

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TMacro

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TMakeRule

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TMakeTarget

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TMember

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TMethod

	instanceVariableNames:'isMeta'

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TPackage

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TPrologClause

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TStruct

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TTypedef

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TUnion

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

Tag subclass:#TVariable

	instanceVariableNames:''

	classVariableNames:''

	poolDictionaries:''

	privateIn:Tag

!

!Tag class methodsFor:'documentation'!

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.

"

!

documentation

"

    keeps the info for a single tag (for the fileBrowser, for example);

    either read from an external tool (ctags) or generated internally

"

! !

!Tag class methodsFor:'instance creation'!

label:aLabel pattern:aPattern

    ^ self label:aLabel pattern:aPattern type:nil lineNumber:nil className:nil

!

label:aLabel pattern:aPattern type:tagTypeString

    ^ self label:aLabel pattern:aPattern type:tagTypeString lineNumber:nil className:nil

!

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

    ^ self label:aLabel pattern:aPattern type:tagTypeString lineNumber:aLineNumer className:nil

!

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

    |tid cls tag|

    ((self == Tag) and:[tagTypeString size == 1]) ifTrue:[

        tid := tagTypeString asString.

        cls := self subclasses detect:[:aClass| aClass typeIdentifier = tid ]

                               ifNone:self.

    ] ifFalse:[

        cls := self

    ].

    tag := cls new.

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

    ^ tag

    "Modified: / 05-05-2011 / 15:42:45 / cg"

! !

!Tag class methodsFor:'accessing'!

typeIdentifier

    ^ nil

! !

!Tag methodsFor:'accessing'!

fileName

    "returns the fileName (project tags only)

    "

    ^ fileName

!

fileName:aFilename

    "set the fileName (project tags only)

    "

    fileName := aFilename

!

label

    ^ label

!

lineNumber

    "returns the lineNumber computed at beginning

    "

    ^ lineNumber ? 0

!

lineNumber:aNumber

    "set the lineNumber computed at beginning

    "

    lineNumber := aNumber.

!

pattern

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

     contents

    "

    ^ pattern

!

typeIdentifierInList

    ^ self class typeIdentifier

!

typeString

    ^ '???'

! !

!Tag methodsFor:'instance creation'!

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

    label      := aLabel.

    pattern    := aPattern.

    lineNumber := aLineNumer.

    cName size > 1 ifTrue:[

	cName first isLetter ifFalse:[

	    className := cName copyFrom:2

	] ifTrue:[

	    className := cName

	]

    ]

! !

!Tag methodsFor:'list interface'!

explainString

    |s t|

    s := label , ' is a ' , self typeString.

    fileName notNil ifTrue:[

	s := s , ' in ', fileName pathName.

    ].

    ^ s

!

printString

    "returns the label used in a list

    "

    |l type|

    l := label.

    className notNil ifTrue:[

	l := className , '::' , l

    ].

"/

"/    type := self class typeIdentifier.

"/

"/    type notNil ifTrue:[

"/        ^  type, ' ' , l

"/    ].

    ^ l

!

printStringWithoutClass

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

    "

    |l type|

    l := label.

    className notNil ifTrue:[

	l := '::' , l

    ].

"/

"/    type := self class typeIdentifier.

"/

"/    type notNil ifTrue:[

"/        ^  type, ' ' , l

"/    ].

    ^ l

!

shortInfoString

    |s|

    s := self typeString.

    fileName notNil ifTrue:[

        s := s , ' in ', fileName baseName "pathName".

    ].

    ^ s

! !

!Tag methodsFor:'queries'!

widthOn:aGC

    width isNil ifTrue:[

	width := self printString widthOn:aGC

    ].

    ^ width

! !

!Tag methodsFor:'tag searching'!

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"

    |pat lnr atStartOfLine atEndOfLine findFirst|

    (lineNumber notNil and:[lineNumber ~~ 0]) ifTrue:[

       ^ lineNumber

    ].

    (pat := self pattern) isNil ifTrue:[

        lineNumber := 1.

        ^ lineNumber

    ].

    (pat endsWith:';"') ifTrue:[

        lnr := Integer readFrom:pat onError:nil.

        lnr notNil ifTrue:[

            ^ lnr

        ]

    ].

    lnr := 0.

"/        (pat endsWith:'/;"') ifTrue:[

"/            pat := pat copyButLast:3.

"/        ].

    (pat startsWith:$^) ifTrue:[

        pat := pat copyFrom:2.

        atStartOfLine := true.

    ].

    (pat endsWith:$$) ifTrue:[

        pat := pat copyButLast.

        atEndOfLine := true.

    ].

    "/ search either in the collection of lines or the file's contents

    findFirst := 

        [:comparer |

            someStringCollectionOrFilename isFilename ifTrue:[

                [:exit |

                    |lineNr|

                    lineNr := 1.

                    someStringCollectionOrFilename readingLinesDo:[:line |

                        (comparer value:line) ifTrue:[exit value:lineNr].

                        lineNr := lineNr + 1.

                    ]

                ] valueWithExit

            ] ifFalse:[

                someStringCollectionOrFilename findFirst:comparer

            ].    

        ].

    atStartOfLine == true ifTrue:[

        atEndOfLine == true ifTrue:[

            lnr := findFirst value:[:line | line = pat].

        ] ifFalse:[

            lnr := findFirst value:[:line | line startsWith:pat].

        ]

    ] ifFalse:[

        atEndOfLine == true ifTrue:[

            lnr := findFirst value:[:line | line endsWith:pat].

        ] ifFalse:[

            lnr := findFirst value:[:line | line includesString:pat].

        ].

    ].

    lnr == 0 ifTrue:[

        lnr := findFirst value:[:line | line includesString:self label].

        lnr == 0 ifTrue:[

            lnr := 1.

        ].

    ].

    ^ lnr

    "Modified: / 12-03-2019 / 15:08:32 / Claus Gittinger"

! !

!Tag methodsFor:'testing'!

isClassTag

    "return true, if this is a java class tag 

    "

    ^ false

!

isDocumentationTag

    "return true, if this is a doc tag 

    "

    ^ false

    "Created: / 08-05-2011 / 10:06:11 / cg"