Class: BackgroundSourceProcessingService (in Tools)

• Inheritance
• Description
• Class protocol
  • queries
• Instance protocol
  • accessing-defaults
  • change & update
  • event handling
  • initialization
  • processing
  • registering

Inheritance:

   Object
   |
   +--Tools::CodeViewService
      |
      +--Tools::BackgroundSourceProcessingService
         |
         +--Tools::CodeHighlightingService

Package:

stx:libtool

Category:

Interface-CodeView

Version:

rev: 1.25 date: 2024/04/09 10:20:10

user: stefan

file: Tools__BackgroundSourceProcessingService.st directory: libtool

module: stx stc-classLibrary: libtool

Description:

An abstract base class for all services that process current
(displayed) source code. All processing is done in background
job, that is restarted whenever a text in the editor is changed.


[instance variables:]
    job         <BackgroundJob> A background job.

[class variables:]

copyright
COPYRIGHT (c) 2006 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:

 isAbstract

Instance protocol:

 defaultJobName

Returns a human-readable job name, to ease identification in process browser

 modelChanged

Model has changed (i.e. value holder keeping displayed text

 sourceChanged: force

Called when codeview's text changes

 update: aspect with: param from: sender

sender == textView modifiedChannel ifTrue:[^self codeChanged: false].

 linesDeletedFrom: start to: end

 linesInsertedFrom: start to: end

 linesModifiedFrom: start to: end

 initialize

(comment from inherited method)
just to ignore initialize to objects which do not need it

 process

(Re)starts the processing job. Should be called whenever a source
must be (re)processed.

 process: delayed

Actually process source code. If `delayed` is true, view should be updated
asynchronously using #pushUserEvent:. Individual services should override
this method.

NOTE: Do not call this method from custom code directly, always call
#processSafely: which handles possible errors and protects against 'debugger bomb'

** This method must be redefined in concrete classes (subclassResponsibility) **

 processSafely: delayed

Process source code. If `delayed` is true, view should be updated
asynchronously using #pushUserEvent:

 registerIn: aCodeView

(comment from inherited method)
Installs myself in aCodeView

 unregister

(comment from inherited method)
Uninstall myself from my codeView