Tools__BackgroundSourceProcessingService.st
author Claus Gittinger <cg@exept.de>
Tue, 05 Jun 2012 23:59:55 +0200
changeset 11558 0e93cd2b9c48
parent 11183 a0ab27f5679c
child 11618 29842c419b87
permissions -rw-r--r--
fixed process priorities
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     1
"{ Package: 'stx:libtool' }"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     2
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     3
"{ NameSpace: Tools }"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     4
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     5
CodeViewService subclass:#BackgroundSourceProcessingService
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     6
	instanceVariableNames:'job done modified'
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     7
	classVariableNames:''
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     8
	poolDictionaries:''
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
     9
	category:'Interface-CodeView'
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    10
!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    11
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    12
!BackgroundSourceProcessingService class methodsFor:'documentation'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    13
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    14
documentation
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    15
"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    16
    An abstract base class for all services that process current
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    17
    (displayed) source code. All processing is done in background
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    18
    job, that is restarted whenever a text in the editor is changed.
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    19
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    20
    [author:]
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    21
        Jan Vrany <jan.vrany@fit.cvut.cz>
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    22
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    23
    [instance variables:]
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    24
        job         <BackgroundJob> A background job.
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    25
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    26
    [class variables:]
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    27
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    28
    [see also:]
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    29
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    30
"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    31
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    32
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    33
!BackgroundSourceProcessingService class methodsFor:'testing'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    34
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    35
isAbstract
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    36
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    37
    ^self == Tools::BackgroundSourceProcessingService
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    38
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    39
    "Created: / 24-01-2012 / 12:27:23 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    40
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    41
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    42
!BackgroundSourceProcessingService methodsFor:'acessing-defaults'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    43
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    44
defaultJobName
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    45
    "Returns a human-readable job name, to ease identification in process browser"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    46
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    47
    ^ 'CodeView2''s source processing job'
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    48
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    49
    "Created: / 24-01-2012 / 12:05:32 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    50
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    51
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    52
!BackgroundSourceProcessingService methodsFor:'change & update'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    53
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    54
sourceChanged:force
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    55
    "Called when codeview's text changes"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    56
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    57
    (force or:[codeView textView modified]) ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    58
        self process
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    59
    ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    60
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    61
    "Modified: / 22-08-2011 / 13:51:53 / cg"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    62
    "Modified (format): / 05-09-2011 / 05:06:40 / cg"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    63
    "Modified: / 24-01-2012 / 12:25:57 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    64
!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    65
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    66
update:aspect with:param from:sender 
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    67
    textView notNil ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    68
        "/sender == textView modifiedChannel ifTrue:[^self codeChanged: false].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    69
        sender == textView model ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    70
            ^ self sourceChanged:true
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    71
        ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    72
        (sender == textView and:[aspect == #sizeOfContents]) ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    73
            ^ self sourceChanged:true
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    74
        ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    75
    ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    76
    codeView notNil ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    77
        sender == codeView languageHolder ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    78
            ^ self sourceChanged:true
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    79
        ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    80
        sender == codeView classHolder ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    81
            ^ self sourceChanged:true
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    82
        ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    83
    ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    84
    super 
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    85
        update:aspect
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    86
        with:param
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    87
        from:sender
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    88
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    89
    "Created: / 06-03-2010 / 19:38:07 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    90
    "Modified: / 13-09-2011 / 12:00:29 / cg"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    91
    "Modified: / 16-09-2011 / 17:30:16 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    92
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    93
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    94
!BackgroundSourceProcessingService methodsFor:'event handling'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    95
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    96
linesDeletedFrom:start to:end 
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    97
    self sourceChanged:true
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    98
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
    99
    "Created: / 06-07-2011 / 17:14:36 / jv"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   100
    "Created: / 16-09-2011 / 15:18:24 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   101
!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   102
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   103
linesInsertedFrom:start to:end 
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   104
    self sourceChanged:true
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   105
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   106
    "Created: / 06-07-2011 / 17:14:36 / jv"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   107
    "Created: / 16-09-2011 / 15:18:21 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   108
!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   109
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   110
linesModifiedFrom:start to:end 
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   111
    self sourceChanged:true
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   112
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   113
    "Created: / 06-07-2011 / 17:14:36 / jv"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   114
    "Created: / 16-09-2011 / 15:15:14 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   115
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   116
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   117
!BackgroundSourceProcessingService methodsFor:'initialization'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   118
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   119
initialize
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   120
    job := (Smalltalk at:#BackgroundJob) 
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   121
                named:self defaultJobName
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   122
                on:[self process:true].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   123
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   124
    "Created: / 29-07-2011 / 10:31:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   125
    "Modified: / 03-08-2011 / 16:47:53 / cg"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   126
    "Modified (format): / 26-09-2011 / 15:39:56 / cg"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   127
    "Modified: / 24-01-2012 / 12:26:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   128
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   129
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   130
!BackgroundSourceProcessingService methodsFor:'processing'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   131
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   132
process
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   133
    "(Re)starts the processing job. Should be called whenever a source 
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   134
     must be (re)processed."
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   135
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   136
    | prio browser |
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   137
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   138
    "/ this clobbers the codeViews modified state; therefore, we have to remember
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   139
    "/ this info somewhere ...
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   140
    (browser := codeView browser) notNil ifTrue:[
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   141
        textView modified ifTrue:[
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   142
            browser navigationState realModifiedState: true
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   143
        ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   144
        textView modifiedChannel setValue:false.
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   145
    ].
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   146
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   147
    job scheduled ifTrue:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   148
        job running ifFalse:[
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   149
            "/ process already created, but did not get a change to start yet;
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   150
            ^ self
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   151
        ].
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   152
        job stop.
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   153
    ].
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   154
    prio := Processor userBackgroundPriority.
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   155
    job startWithPriority: prio.
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   156
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   157
    "Modified: / 07-07-2011 / 12:26:12 / Jan Vrany <jan.vrant@fit.cvut,cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   158
    "Created: / 24-01-2012 / 12:15:08 / Jan Vrany <jan.vrany@fit.cvut.cz>"
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   159
    "Modified: / 05-06-2012 / 23:58:20 / cg"
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   160
!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   161
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   162
process: delayed
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   163
    "Do the real source processing. If delayed is true, actuall data update must
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   164
     be done within the event queue using #pushUserEvent:...
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   165
     "
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   166
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   167
    self subclassResponsibility
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   168
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   169
    "Created: / 24-01-2012 / 12:25:17 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   170
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   171
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   172
!BackgroundSourceProcessingService methodsFor:'registering'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   173
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   174
registerIn: aCodeView
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   175
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   176
    super registerIn: aCodeView.
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   177
    textView addDependent: self.
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   178
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   179
    "Created: / 27-07-2011 / 13:25:03 / Jan Vrany <jan.vrany@fit.cvut.cz>"
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   180
! !
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   181
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   182
!BackgroundSourceProcessingService class methodsFor:'documentation'!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   184
version
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   185
    ^ '$Header: /cvs/stx/stx/libtool/Tools__BackgroundSourceProcessingService.st,v 1.2 2012-06-05 21:59:55 cg Exp $'
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   186
!
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   187
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   188
version_CVS
11558
0e93cd2b9c48 fixed process priorities
Claus Gittinger <cg@exept.de>
parents: 11183
diff changeset
   189
    ^ '$Header: /cvs/stx/stx/libtool/Tools__BackgroundSourceProcessingService.st,v 1.2 2012-06-05 21:59:55 cg Exp $'
11183
a0ab27f5679c initial checkin
vrany
parents:
diff changeset
   190
! !