"

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

"{ NameSpace: Smalltalk }"

IdentityDictionary subclass:#UserPreferences

	instanceVariableNames:'modified'

	classVariableNames:'CurrentPreferences DefaultPreferences'

	poolDictionaries:''

	category:'System-Support'

!

!UserPreferences class methodsFor:'documentation'!

copyright

"

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

"

    A Dictionary for user preference values.

    For non-existing keys, either a defaultValue (false),

    or the value from a defaultDictionary is returned.

    This will eventually keep track of ALL user preferences.

    For now, not all preferences are found here -

    (some of them are currently spread over the system - especially, in Class-Variables)

    - but this will change over time.

    If more prefs are added, think about adding a corresponding UI to the SystemSettingsDialog too.

    Notice, that ST/X is intended to be multi-user capable, supporting multiple users on multiple screens.

    This is effectively used by (at least) 2 ST/X customers we are aware of (for multi-screen applications).

    So do not break it, by putting user-specific stuff into class variables.

    Usage:

        UserPreferences current at:#foo

    or

        UserPreferences current at:#foo put:something

"

! !

!UserPreferences class methodsFor:'initialization'!

initializeDefaultsIn:preferences

    Color isNil "Smalltalk isStandAloneApp" ifTrue:[

        ^ self.

    ].

    Color initialize.

    #(

        #useNewChangesBrowser           false

        #useNewInspector                false

        #showClockInLauncher            true

        #autoFormatting                 false

        #syntaxColoring                 true

        #fullSelectorCheck              false

        #defaultSyntaxColor             (Color black)

        #defaultSyntaxEmphasis          normal

        #errorColor                     (Color red)

        "/ #commentColor                   (Color 12.5 12.5 100)

        #commentColor                   (Color 0 50 0)

        #commentEmphasis                normal

        #methodSelectorEmphasis         bold

        #selectorEmphasis               bold

        #unimplementedSelectorColor     (Color red)

        #unimplementedSelectorEmphasis  normal

        "/ I prefer red-underwave over red identifier ...

        "/      #badIdentifierColor                 (Color red)

        #instVarIdentifierColor         (Color 33 0 33)

        "/ I prefer redish background

        "/      #sideEffectAssignmentColor          (Color 75 0 0)

        "/ #sideEffectAssignmentBackgroundColor    (Color 100 86 86)

        #jsKeywordEmphasis              bold

        "/ #jsKeywordColor                 (Color black)

        #jsKeywordColor                 (Color 33 33 0)

        #controlFlowSelectorColor       (Color 0 0 100)

        #debugSelectorColor             (Color 80 0 0)

        #errorRaisingSelectorColor      (Color 80 0 0)

        "/ #constantColor                  (Color 25 0 0)

        #constantColor                  (Color 64 8 8)

        #globalIdentifierColor          (Color 67 0 67)

        #unknownIdentifierColor         (Color 67 0 67)

        #returnColor                    (Color 0 0 100)

        #returnEmphasis                 bold

     ) pairWiseDo:[:k :v |

        preferences at:k put:(v decodeAsLiteralArray).

    ].

    "/ I prefer red-underwave over red identifier ...

    preferences at:#badIdentifierEmphasis put:(Array with:#underwave with:(#underlineColor->Color red)).

    "

     self initializeDefaultPreferences

    "

    "Created: / 06-06-2016 / 10:42:14 / cg"

!

readSettingsFile

    "read the settings from standard places,

     If a --preferences command line argument was given, read it from there"

    "JV@2012-03-07: Try following settings files:

       $HOME/.smalltalk/settings.stx

       $HOME/.smalltalk/settings.rc

       $PWD/settings.stx

       $PWD/settings.rc

    in that order. Whichever is found, it is read and the rest

    is not used. Also, path to the file which has beed read is

    stored in 'UserPreferences current at:#settingsFilename'

    "

    |commandLineArguments files continue idx|

    files := nil.

    commandLineArguments := Smalltalk commandLineArguments.

    idx := commandLineArguments indexOf: '--preferences'.

    idx ~~ 0 ifTrue:[

        | file |

        commandLineArguments size <= idx ifTrue:[

            self error:'UserPreferences [error]: --preferences requires an argument, none given'

        ].

        file := (Smalltalk commandLineArguments at: idx + 1) asFilename.

        file exists ifFalse:[

            self error:('UserPreferences [error]: preference file ''', file pathName,''' does not exist').

        ].

        file isDirectory ifTrue:[

            self error:('UserPreferences [error]: preference file ''', file pathName,''' is not a regular file').

        ].

        file isReadable ifFalse:[

            self error:('UserPreferences [error]: preference file ''', file pathName,''' is not readable (check permissions)').

        ].

        files := Array with: file.

        commandLineArguments removeAtIndex: idx + 1.

        commandLineArguments removeAtIndex: idx.

    ].

    files isNil ifTrue:[

        files := {

                    (Filename homeDirectory / '.smalltalk' / 'settings.stx') . "/ per-user settings file (new default?)

                    (Filename homeDirectory / '.smalltalk' / 'settings.rc') .  "/ for backward compatibility with jv-branch

                    (Smalltalk getSystemFileName: 'settings.stx') .            "/ old stx default

                    (Smalltalk getSystemFileName: 'settings.rc') .             "/ for backward compatibility with jv-branch

                 }.

    ].

    continue := true.

    files do:[:each|

        | eachFile |

        (continue and:[each notNil and:[(eachFile := each asFilename) exists]]) ifTrue:[

            continue := false.

            eachFile pathName infoPrintCR.

            eachFile fileIn.

            UserPreferences current at:#settingsFilename put: eachFile pathName.

        ].

    ].

    continue ifTrue:[

        Smalltalk silentLoading ifFalse:[

            'UserPreferences [info]: no settings.stx file found' infoPrintCR 

        ].

    ].

    "Created: / 16-07-2018 / 12:50:32 / Claus Gittinger"

! !

!UserPreferences class methodsFor:'accessing'!

current

    CurrentPreferences isNil ifTrue:[

        CurrentPreferences := self new.

        self initializeDefaultsIn:CurrentPreferences.

        CurrentPreferences flyByHelpSettingChanged.

    ].

    ^ CurrentPreferences.

    "

     CurrentPreferences := nil

    "

    "Modified: / 05-02-2015 / 07:08:21 / Jan Vrany <jan.vrany@fit.cvut.cz>"

    "Modified: / 06-06-2016 / 10:42:59 / cg"

!

currentSettingsFilename

    | file |

    file := self current at:#settingsFilename ifAbsent:[nil].

    file isNil ifTrue:[

        file := self defaultUserSettingsFile.

    ].

    ^ file.

!

default

    DefaultPreferences isNil ifTrue:[

        DefaultPreferences := self new.

        self initializeDefaultsIn:DefaultPreferences

    ].

    ^ DefaultPreferences.

    "

     DefaultPreferences := nil.

    "

    "Modified: / 06-06-2016 / 10:41:45 / cg"

!

reset

    "resets the CurrentPreferences to its default values"

    CurrentPreferences := nil

!

setCurrent:preferencesInstance

    "sets the CurrentPreferences to preferencesInstance"

    CurrentPreferences := preferencesInstance

!

syntaxColorKeys

    "returns the keys of syntax color items"

    ^ self syntaxColorNamesAndKeys collectAll:[:each | each from:2]

    "

     self syntaxColorKeys

    "

"/    ^#(

"/        argumentIdentifierColor

"/          argumentIdentifierEmphasis

"/        booleanConstantColor

"/          booleanConstantEmphasis

"/        bracketColor

"/          bracketEmphasis

"/        classVariableIdentifierColor

"/          classVariableIdentifierEmphasis

"/        constantColor

"/          constantEmphasis

"/        controlFlowSelectorColor

"/          controlFlowSelectorEmphasis

"/        commentColor

"/          commentEmphasis

"/        defaultSyntaxColor

"/          defaultSyntaxEmphasis

"/        errorColor

"/        globalIdentifierColor

"/          globalIdentifierEmphasis

"/        globalClassIdentifierColor

"/          globalClassIdentifierEmphasis

"/        hereColor

"/          hereEmphasis

"/        identifierColor

"/          identifierEmphasis

"/        instVarIdentifierColor

"/          instVarIdentifierEmphasis

"/        localIdentifierColor

"/          localIdentifierEmphasis

"/        methodSelectorColor

"/          methodSelectorEmphasis

"/        poolVariableIdentifierColor

"/          poolVariableIdentifierEmphasis

"/        returnColor

"/          returnEmphasis

"/        selectorColor

"/          selectorEmphasis

"/        selfColor

"/          selfEmphasis

"/        stringColor

"/          stringEmphasis

"/        superColor

"/          superEmphasis

"/        symbolColor

"/          symbolEmphasis

"/        thisContextColor

"/          thisContextEmphasis

"/        unknownIdentifierColor

"/          unknownIdentifierEmphasis

"/        unimplementedSelectorColor

"/          unimplementedSelectorEmphasis

"/        sideEffectAssignmentBackgroundColor

"/          sideEffectAssignmentColor

"/        colorForInstrumentedFullyCoveredCode

"/            emphasisForInstrumentedFullyCoveredCode

"/        colorForInstrumentedPartiallyCoveredCode

"/            emphasisForInstrumentedPartiallyCoveredCode

"/        colorForInstrumentedNeverCalledCode

"/            emphasisForInstrumentedNeverCalledCode

"/    )

    "Modified: / 14-02-2012 / 10:17:46 / cg"

!

syntaxColorNames

    "returns the syntax colors for the settings in the launcher"

    ^ self syntaxColorNamesAndKeys collect:#first.

"/"/ warning, the strings below are presented to the user

"/"/ as the syntax-color boxes comboList - however, they are

"/"/ also used (without separators) as key into myself.

"/"/ Therefore, do not change the strings below.

"/"/ I know - this is bad coding ....

"/

"/^#(

"/'Argument Identifier Color'

"/'Boolean Constant Color'

"/'Bracket Color'

"/'Class Variable Identifier Color'

"/'Collection Enumeration Selector Color'

"/'Constant Color'

"/'Control Flow Selector Color'

"/'Comment Color'

"/'Debug Selector Color'

"/'Error Raising Selector Color'

"/'Global Identifier Color'

"/'Global Class Identifier Color'

"/'Here Color'

"/'Identifier Color'

"/'InstVar Identifier Color'

"/'Local Identifier Color'

"/'Method Selector Color'

"/'Pool Variable Identifier Color'

"/'Return Color'

"/'Selector Color'

"/'Self Color'

"/'Side Effect Assignment Color'

"/'Side Effect Assignment Background Color'

"/'String Color'

"/'Super Color'

"/'Symbol Color'

"/'This Context Color'

"/'Unknown Identifier Color'

"/'Unimplemented Selector Color'

"/'Side Effect Assignment Color'

"/'Coverage: Reached Color'

"/'Coverage: Partially Reached Color'

"/'Coverage: Unreached Color'

"/)

    "Modified: / 14-02-2012 / 15:51:38 / cg"

!

syntaxColorNamesAndKeys

    "returns the names and keys of syntax color items"

    ^#(

	(

	  'Argument Identifier Color'

	  argumentIdentifierColor

	  argumentIdentifierEmphasis

	)

	(

	  'Boolean Constant Color'

	  booleanConstantColor

	  booleanConstantEmphasis

	)

	(

	  'Bracket Color'

	  bracketColor

	  bracketEmphasis

	)

	(

	  'Class Variable Identifier Color'

	  classVariableIdentifierColor

	  classVariableIdentifierEmphasis

	)

	(

	  'Constant Color'

	  constantColor

	  constantEmphasis

	)

	(

	  'Control Flow Selector Color'

	  controlFlowSelectorColor

	  controlFlowSelectorEmphasis

	)

	(

	  'Comment Color'

	  commentColor

	  commentEmphasis

	)

	(

	  'Collection Enumeration Selector Color'

	  collectionEnumerationSelectorColor

	  collectionEnumerationSelectorEmphasis

	)

	(

	  'Debug Selector Color'

	  debugSelectorColor

	  debugSelectorEmphasis

	)

	(

	  'Default Syntax Color'

	  defaultSyntaxColor

	  defaultSyntaxEmphasis

	)

	(

	  'Error Raising Selector Color'

	  errorColor

	  errorEmphasis

	)

	(

	  'Global Identifier Color'

	  globalIdentifierColor

	  globalIdentifierEmphasis

	)

	(

	  'Global Class Identifier Color'

	  globalClassIdentifierColor

	  globalClassIdentifierEmphasis

	)

	(

	  'Here Color'

	  hereColor

	  hereEmphasis

	)

	(

	  'Identifier Color'

	  identifierColor

	  identifierEmphasis

	)

	(

	  'InstVar Identifier Color'

	  instVarIdentifierColor

	  instVarIdentifierEmphasis

	)

	(

	  'Local Identifier Color'

	  localIdentifierColor

	  localIdentifierEmphasis

	)

	(

	  'Method Selector Color'

	  methodSelectorColor

	  methodSelectorEmphasis

	)

	(

	  'Pool Variable Identifier Color'

	  poolVariableIdentifierColor

	  poolVariableIdentifierEmphasis

	)

	(

	  'Return Color'

	  returnColor

	  returnEmphasis

	)

	(

	  'Selector Color'

	  selectorColor

	  selectorEmphasis

	)

	(

	  'Self Color'

	  selfColor

	  selfEmphasis

	)

	(

	  'String Color'