"{ Encoding: utf8 }"

"

 COPYRIGHT (c) 1989 by Claus Gittinger

 COPYRIGHT (c) 2005 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:libcomp' }"

"{ NameSpace: Smalltalk }"

Object subclass:#ParserFlags

	instanceVariableNames:'warnings warnUnusedVars warnUndeclared warnST80Directives

		warnSTXHereExtensionUsed warnSTXSpecialComment

		warnUnderscoreInIdentifier warnOldStyleAssignment

		warnCommonMistakes warnSTXNameSpaceUse

		warnPossibleIncompatibilities warnDollarInIdentifier

		warnParagraphInIdentifier warnHiddenVariables

		warnAboutVariableNameConventions warnAboutWrongVariableNames

		warnAboutBadComments warnInconsistentReturnValues

		warnAboutNonLowercaseLocalVariableNames

		warnAboutPossibleSTCCompilationProblems

		warnAboutReferenceToPrivateClass warnAboutShortLocalVariableNames

		warnAboutPossiblyUnimplementedSelectors

		warnAboutUnknownCharacterEscapesInJavaScriptStringConstant

		warnPlausibilityChecks allowLiteralNameSpaceSymbols

		allowUnderscoreInIdentifier allowDollarInIdentifier

		allowParagraphInIdentifier allowOldStyleAssignment

		allowSqueakExtensions allowDolphinExtensions

		allowExtendedBinarySelectors allowQualifiedNames

		allowFunctionCallSyntaxForBlockEvaluation

		allowLocalVariableDeclarationWithInitializerExpression

		allowDomainVariables allowArrayIndexSyntaxExtension

		allowReservedWordsAsSelectors allowVariableReferences

		allowLazyValueExtension allowFixedPointLiterals

		allowExtendedSTXSyntax allowVisualAgeESSymbolLiterals

		allowExtensionsToPrivateClasses allowSqueakPrimitives

		allowVisualAgePrimitives allowSTVPrimitives allowSTVExtensions

		allowNationalCharactersInIdentifier allowHashAsBinarySelector

		allowSTXEOLComments allowEmptyStatements

		allowVisualWorksMethodAnnotations

		allowPossibleSTCCompilationProblems arraysAreImmutable

		stringsAreImmutable implicitSelfSends stcKeepCIntermediate

		stcKeepOIntermediate stcKeepSTIntermediate stcModulePath

		stcCompilation stcCompilationIncludes stcCompilationDefines

		stcCompilationOptions stcPath ccCompilationOptions ccPath

		linkArgs linkSharedArgs linkCommand libPath searchedLibraries

		warnAboutPeriodInSymbol allowPeriodInSymbol allowCaretAsBinop

		allowUnicodeStrings allowUnicodeCharacters allowCharacterEscapes

		allowStringEscapes allowAssignmentToBlockArgument

		allowAssignmentToMethodArgument allowAssignmentToPoolVariable

		lineNumberInfo allowSTXDelimiterComments

		allowSTXExtendedArrayLiterals warnAssignmentToBlockArgument

		warnAssignmentToMethodArgument warnAssignmentToPoolVariable

		allowSignedByteArrayElements allowSymbolsStartingWithDigit

		allowJavaScriptConst allowPeriodAsNameSpaceSeparator

		allowCStrings'

	classVariableNames:'AllowArrayIndexSyntaxExtension AllowAssignmentToBlockArgument

		AllowAssignmentToMethodArgument AllowAssignmentToPoolVariable

		AllowCaretAsBinop AllowCharacterEscapes AllowDollarInIdentifier

		AllowDolphinExtensions AllowDomainVariables AllowEmptyStatements

		AllowExtendedBinarySelectors AllowExtendedSTXSyntax

		AllowExtensionsToPrivateClasses AllowFixedPointLiterals

		AllowFunctionCallSyntaxForBlockEvaluation

		AllowHashAsBinarySelector AllowLazyValueExtension

		AllowLiteralNameSpaceSymbols

		AllowLocalVariableDeclarationWithInitializerExpression

		AllowNationalCharactersInIdentifier AllowOldStyleAssignment

		AllowParagraphInIdentifier AllowPeriodInSymbol

		AllowPossibleSTCCompilationProblems AllowQualifiedNames

		AllowReservedWordsAsSelectors AllowSTVExtensions

		AllowSTVPrimitives AllowSTXDelimiterComments AllowSTXEOLComments

		AllowSTXExtendedArrayLiterals AllowSqueakExtensions

		AllowSqueakPrimitives AllowStringEscapes

		AllowUnderscoreInIdentifier AllowUnicodeCharacters

		AllowUnicodeStrings AllowVariableReferences

		AllowVisualAgeESSymbolLiterals AllowVisualAgePrimitives

		AllowVisualWorksMethodAnnotations ArraysAreImmutable BCCTop

		CCCompilationOptions CCPath DefineForBorlandC DefineForCLANG

		DefineForGNUC DefineForMINGW DefineForMINGW32 DefineForMINGW64

		DefineForMSC DefineForVisualC ForcedCompiler ImplicitSelfSends

		LibDirectory LibPath LineNumberInfo LinkArgs LinkCommand

		LinkSharedArgs MakeCommand MingwTop PerMethodFlags SDKTop

		STCCompilation STCCompilationDefines STCCompilationIncludes

		STCCompilationOptions STCKeepCIntermediate STCKeepOIntermediate

		STCKeepSTIntermediate STCModulePath STCPath SearchedLibraries

		StringsAreImmutable VCTop WarnAboutBadComments

		WarnAboutNonLowercaseLocalVariableNames WarnAboutPeriodInSymbol

		WarnAboutPossibleSTCCompilationProblems

		WarnAboutPossiblyUnimplementedSelectors

		WarnAboutReferenceToPrivateClass WarnAboutShortLocalVariableNames

		WarnAboutUnknownCharacterEscapesInJavaScriptStringConstant

		WarnAboutVariableNameConventions WarnAboutWrongVariableNames

		WarnAssignmentToBlockArgument WarnAssignmentToMethodArgument

		WarnAssignmentToPoolVariable WarnCommonMistakes

		WarnDollarInIdentifier WarnHiddenVariables

		WarnInconsistentReturnValues WarnOldStyleAssignment

		WarnParagraphInIdentifier WarnPlausibilityChecks

		WarnPossibleIncompatibilities WarnST80Directives WarnSTXSpecials

		WarnUndeclared WarnUnderscoreInIdentifier WarnUnusedVars Warnings

		AutoDefineVariables AllowSignedByteArrayElements

		AllowSymbolsStartingWithDigit AllowJavaScriptConst

		AllowJavaScriptLet AllowPeriodAsNameSpaceSeparator AllowCStrings'

	poolDictionaries:''

	category:'System-Compiler'

!

!ParserFlags class methodsFor:'documentation'!

copyright

"

 COPYRIGHT (c) 1989 by Claus Gittinger

 COPYRIGHT (c) 2005 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

"

    compiler flags (used to be defined in Scanner and Parser) have been extracted for easier

    individual-method customization (using ST as scripting).

    The class side provides correspondingly-named variables, which hold the default values.

    howTo_fileInVSE:

        ParserFlags allowSTVExtensions:true.

        ParserFlags allowSTVPrimitives:true.

        ParserFlags allowSTXEOLComments:false.

    for stx debugging:

        STCKeepCIntermediate := true

    the flags control:

        Warnings                            -- enable/disable any warnings from the compiler

          WarnUndeclared                    -- warn about undeclared variables

          WarnUnusedVars                    -- warn about unused variables

          WarnST80Directives                -- warn when ST80 (visualworks) directives (primitives) are used

          WarnAboutWrongVariableNames       -- conventions / style

          WarnAboutVariableNameConventions 

          WarnAboutNonLowercaseLocalVariableNames

          WarnAboutShortLocalVariableNames

          WarnAboutBadComments 

          WarnCommonMistakes

          WarnAboutReferenceToPrivateClass

        WarnPossibleIncompatibilities

          WarnSTXSpecials                   -- warn when special ST/X syntax extensions are used

          WarnUnderscoreInIdentifier        -- underscores in identifier (not all Smalltalk dialects support this)

          WarnDollarInIdentifier            -- dollar in identifier (not all Smalltalk dialects support this)

          WarnParagraphInIdentifier         -- paragraph character in identifier

          WarnOldStyleAssignment            -- assignment with _ - character

          WarnHiddenVariables               -- locals shadowing outer/instvars

          WarnInconsistentReturnValues      -- boolean/non-boolean return values

          WarnAboutPeriodInSymbol

          WarnAboutPossibleSTCCompilationProblems

          WarnAboutUnknownCharacterEscapesInJavaScriptStringConstant

          WarnAssignmentToBlockArgument 

          WarnAssignmentToMethodArgument

          WarnAssignmentToPoolVariable

        WarnPlausibilityChecks

          WarnAboutPossiblyUnimplementedSelectors

       AllowReservedWordsAsSelectors

       AllowUnderscoreInIdentifier 

       AllowParagraphInIdentifier 

       AllowDollarInIdentifier              -- st80-vms dollars in identifiers

       AllowOldStyleAssignment              -- st80 underscore as assignment

       AllowDolphinExtensions               -- dolphin computed literal

       AllowQualifiedNames                  -- vw3 qualified names

       AllowExtendedBinarySelectors         -- vw5.4 extended binary selectors (plus/minus, center-dot etc.)

       AllowCaretAsBinop                    -- too dangerous

       AllowLiteralNameSpaceSymbols         -- st/x literal nameSpace-symbols (#foo::bar)

       AllowArrayIndexSyntaxExtension 

       AllowFunctionCallSyntaxForBlockEvaluation 

       AllowLocalVariableDeclarationWithInitializerExpression 

       AllowDomainVariables 

       AllowArrayIndexSyntaxExtension 

       AllowReservedWordsAsSelectors 

       AllowVariableReferences 

       AllowLazyValueExtension 

       AllowFixedPointLiterals 

       AllowExtendedSTXSyntax 

       AllowVisualAgeESSymbolLiterals 

       AllowExtensionsToPrivateClasses 

       AllowVisualAgePrimitives 

       AllowSqueakExtensions                -- squeak computed array

       AllowSqueakPrimitives 

       AllowSTVPrimitives                   -- number-sign syntax

       AllowSTVExtensions 

       AllowNationalCharactersInIdentifier 

       AllowHashAsBinarySelector 

       AllowSTXEOLComments                  -- DQuote/ EOL comments

       AllowSTXDelimiterComments            -- DQuote<<END delimiter comments

       AllowVisualWorksMethodAnnotations 

       AllowPossibleSTCCompilationProblems  -- must be true, to allow fileIn

       AllowEmptyStatements 

       AllowPeriodInSymbol 

       AllowPeriodAsNameSpaceSeparator 

       AllowCStrings                        -- c'....' is a string with C-escapes

       AllowUnicodeStrings 

       AllowUnicodeCharacters 

       AllowCharacterEscapes 

       AllowStringEscapes 

       AllowAssignmentToBlockArgument 

       AllowAssignmentToMethodArgument 

       AllowAssignmentToPoolVariable 

       AllowSignedByteArrayElements 

       AllowSymbolsStartingWithDigit 

       AllowJavaScriptConst               

       ArraysAreImmutable                 -- still care for ST-80 compatibility

       StringsAreImmutable                -- still care for ST-80 compatibility

       ImplicitSelfSends 

"

! !

!ParserFlags class methodsFor:'instance creation'!

new

    ^ self basicNew initialize

! !

!ParserFlags class methodsFor:'accessing-compilation control'!

allowExtensionsToPrivateClasses

    ^ AllowExtensionsToPrivateClasses

!

allowExtensionsToPrivateClasses:aBoolean

    AllowExtensionsToPrivateClasses := aBoolean

!

allowPossibleSTCCompilationProblems

    ^ AllowPossibleSTCCompilationProblems

    "

     self allowPossibleSTCCompilationProblems:true

     self allowPossibleSTCCompilationProblems:false

     self warnAboutPossibleSTCCompilationProblems

    "

    "Created: / 16-11-2006 / 14:31:36 / cg"

!

allowPossibleSTCCompilationProblems:aBoolean

    AllowPossibleSTCCompilationProblems := aBoolean

    "Created: / 16-11-2006 / 14:31:40 / cg"

!

arraysAreImmutable

    "return true if arrays and byteArrays are compiled as immutable literals"

    ^ ArraysAreImmutable

!

arraysAreImmutable:aBoolean

    "turn on/off immutable array and byteArrays literals - default is false for ST-80 compatibilty."

    ArraysAreImmutable := aBoolean.

    "

     can be added to your private.rc file:

     ParserFlags arraysAreImmutable:true

     ParserFlags arraysAreImmutable:false

    "

!

fullLineNumberInfo

    ^ (self lineNumberInfo == #full)

    "Created: / 26-09-2012 / 14:16:09 / cg"

!

implicitSelfSends

    "return true if undefined variables with

     lowercase first character are to be turned

     into implicit self sends"

    ^ ImplicitSelfSends

!

implicitSelfSends:aBoolean

    "turn on/off implicit self sends"

    ImplicitSelfSends := aBoolean

    "

     Compiler implicitSelfSends:true

     Compiler implicitSelfSends:false

    "

!

lineNumberInfo

    ^ LineNumberInfo

    "Created: / 26-09-2012 / 13:27:34 / cg"

!

lineNumberInfo:aSymbol

    LineNumberInfo := aSymbol.

    "Created: / 26-09-2012 / 13:27:54 / cg"

!

stringsAreImmutable

    "return true if strings are immutable literals"

    ^ StringsAreImmutable

    "Created: / 3.8.1998 / 14:53:25 / cg"

!

stringsAreImmutable:aBoolean

    "turn on/off immutable string literals - default is false for ST-80 compatibilty."

    StringsAreImmutable := aBoolean.

    "

     can be added to your private.rc file:

     ParserFlags stringsAreImmutable:true

     ParserFlags stringsAreImmutable:false

    "

    "Created: / 3.8.1998 / 14:53:28 / cg"

! !

!ParserFlags class methodsFor:'accessing-per method flags'!

disableFlag:flagName forClass:class selector:selector

    "remember that warnings named flagName (such as #warnUnusedVars)

     are disabled for a particular method.

     Sent if user wants to disable warnings in the future

     (try defining a method with an unused var, to see)"

    |key|

    PerMethodFlags isNil ifTrue:[

	PerMethodFlags := Dictionary new.

    ].

    key := class name, '>>',selector.

    PerMethodFlags at:key put:(Timestamp now + self perMethodDisableWarningTimeDuration).

    "Created: / 28-02-2012 / 12:57:45 / cg"

!

isFlag:flagName enabledForClass:class selector:selector

    "return true, if warnings named <flagName> (such as #warnUnusedVars)

     are to be suppressed for a particular method."

    |key endTime|

    PerMethodFlags isNil ifTrue:[^ true].

    class isNil ifTrue:[^ true].

    selector isNil ifTrue:[^ true].

    key := class name, '>>',selector.

    endTime := PerMethodFlags at:key ifAbsent:nil.

    endTime isNil ifTrue:[^ true].

    endTime > Timestamp now ifTrue:[^ false].

    PerMethodFlags removeKey:key.

    ^ true

    "Created: / 28-02-2012 / 12:57:30 / cg"

!

perMethodDisableWarningTimeDuration

    "when the user wants to suppress a particular warning for a particular

     method, it will be only suppressed for some time duration.

     After that, the suppress will automatically be removed, and normal warnings

     are issued again."

    ^ 30 minutes

    "Created: / 08-03-2012 / 10:22:57 / cg"

!

reenableAllSuppressedFlags

    "turn off any suppressed warnings"

    PerMethodFlags := nil

    "Created: / 28-02-2012 / 12:59:08 / cg"

! !

!ParserFlags class methodsFor:'accessing-stc compilation control'!

bccTop:aPath

    "windows only: define the borland-C installation directory.

     must contain bin\bcc32.exe and include.

     Typically, something like 'C:\borland\bcc55'"

    BCCTop := aPath

    "Created: / 08-08-2011 / 22:41:48 / cg"

!

ccCompilationOptions

    ^ CCCompilationOptions ? ''

!

ccCompilationOptions:aString

    CCCompilationOptions := aString

!

ccPath

    ^ CCPath

!

ccPath:aSymbol

    CCPath := aSymbol

!

libDirectory

    ^ LibDirectory

    "Created: / 07-08-2011 / 14:01:21 / cg"

!

libDirectory:aString

    LibDirectory := aString

    "Created: / 07-08-2011 / 14:01:28 / cg"

!

libPath

    ^ LibPath

!

libPath:aString

    LibPath := aString

!

linkArgs

    ^ LinkArgs

!

linkArgs:aString

    LinkArgs := aString

!

linkCommand

    ^ LinkCommand

!

linkCommand:aString

    LinkCommand := aString

!

linkSharedArgs

    ^ LinkSharedArgs

!

linkSharedArgs:aString

    LinkSharedArgs := aString

    "Modified (format): / 28-02-2012 / 13:34:58 / cg"

!

makeCommand

    ^ MakeCommand

    "Created: / 09-08-2006 / 18:45:04 / fm"

!

makeCommand:aString

    MakeCommand := aString

    "Created: / 09-08-2006 / 18:45:12 / fm"

!

sdkTop:aPath

    "windows only: define the SDK top directory.

     must include folder with windows header files.

     Typically something like 'C:\Program Files\Microsoft SDKs\Windows\v6.0A'"

    SDKTop := aPath