Class: ProgrammingLanguage

• Inheritance
• Description
• Class protocol
  • Signal constants
  • accessing
  • enumerating
  • initialization
  • instance creation
  • private
  • testing
• Instance protocol
  • accessing
  • accessing - classes
  • printing & storing
  • queries
  • testing
  • utilities - file in/file out
  • utilities - source code

Inheritance:

   Object
   |
   +--ProgrammingLanguage
      |
      +--STXJavaScriptLanguage
      |
      +--SmalltalkLanguage

Package:

stx:libbasic

Category:

Kernel-Languages

Version:

rev: 1.10 date: 2009/12/04 11:21:32

user: cg

file: ProgrammingLanguage.st directory: libbasic

module: stx stc-classLibrary: libbasic

Description:

provide info about which tools are to be used for code in
a programming language

Class protocol:

 languageQuerySignal

 all

Anwers a collection of all available languages

 current

ProgrammingLanguage current

 instance

return this languages singleton

 allDetect: aBlock ifNone: exceptionValue

 allDo: aBlock

 initialize

 forFile: aFilename

Answers a language for given source file. If none is found,
SmalltalkLanguage is returned (to provide backward compatibility)

 forStream: aStream

Answers a language for given source stream. If none is found,
SmalltalkLanguage is returned (to provide backward compatibility)

 named: aString

 named: aString ifNone: aBlock

 instancesDetect: detectBlock ifNone: failBlock

 isAvailable: langName

Instance protocol:

 name

Answers a human-readable name of myself:
'Smalltalk' for SmalltalkLanguage,
'Ruby' for RubyLanguage
...


** This method raises an error - it must be redefined in concrete classes **

 sourceFileSuffix

Answers a default suffix for source files, i.e. 'st' for Smalltalk,
'js' for JavaScript or 'rb' for Ruby', etc.

** This method raises an error - it must be redefined in concrete classes **

 compilerClass

Answer a class suitable for compiling a source code in 'my' language

** This method raises an error - it must be redefined in concrete classes **

 evaluatorClass

Answer a class suitable for evaluating a doIt in 'my' language

 explainerClass

Answers a class used by browser and debugger to
show some hints about the code. It is OK to return
nil, which means that there is no explainer for given
language.

 formatterClass

Answer a class suitable for prettyPrinting (indenting) code in 'my' language.
It is ok to return nil, which means that the browser will not be able to prettyprint.

 parserClass

Answer a class suitable for parsing a source code in 'my' language

** This method raises an error - it must be redefined in concrete classes **

 sourceFileReaderClass

Answers a class that can be used for reading & compiling source files

** This method raises an error - it must be redefined in concrete classes **

 sourceFileWriterClass

Answers a class is used for source file writing (i.e. file-out)

** This method raises an error - it must be redefined in concrete classes **

 syntaxHighlighterClass

Answers a class used by browser and debugger to colorze code.
It is OK to return nil, which means that the code is shown as-is

 storeOn: aStream

 canReadSourceFile: aFilename

Answers true iff file contains source code in 'my' language

 isRuby

true iff this is the ruby language

 isSTXJavaScript

true iff this is the ST/X-javascript language

 isSmalltalk

true iff this is the smalltalk language

 fileIn: aFilename

 fileInStream: aStream

 methodTemplate

return a method definition template string (or nil)

 writeComment: aStringOrStringCollection on: aStream

Utility method - writes a comment to a stream,
using proper syntax