gitHub/stx_libscm_gitHub.st
author Claus Gittinger <cg@exept.de>
Mon, 15 Jul 2019 15:37:27 +0200
branchcvs_MAIN
changeset 880 bd52c31956df
parent 837 87d2bfaa3709
permissions -rw-r--r--
#OTHER by cg unneeded subProjects method removed (already inherited)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
837
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
     1
"{ Encoding: utf8 }"
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
     2
831
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     3
"{ Package: 'stx:libscm/gitHub' }"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     4
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     5
"{ NameSpace: Smalltalk }"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     6
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     7
LibraryDefinition subclass:#stx_libscm_gitHub
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     8
	instanceVariableNames:''
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
     9
	classVariableNames:''
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    10
	poolDictionaries:''
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    11
	category:'* Projects & Packages *'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    12
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    13
837
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    14
!stx_libscm_gitHub class methodsFor:'documentation'!
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    15
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    16
documentation
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    17
"
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    18
     Package documentation:
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    19
 
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    20
     hacks to allow squeak/pharo packages on guthub to be loaded
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    21
     (i.e. converted to a changeset).
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    22
     
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    23
     Notice: does not support downloading the package;
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    24
     so you must fetch the master-zip first, unzip, then get the package(s).
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    25
     
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    26
     [author:]
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    27
         cg
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    28
 
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    29
     [primary maintainer:]
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    30
         cg
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    31
"
87d2bfaa3709 #DOCUMENTATION by cg
Claus Gittinger <cg@exept.de>
parents: 831
diff changeset
    32
! !
831
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    33
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    34
!stx_libscm_gitHub class methodsFor:'description'!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    35
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    36
excludedFromPreRequisites
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    37
    "obsolete; temporarily, this is still called for, but will eventually vanish.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    38
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    39
     List packages which are to be explicitely excluded from the automatic constructed
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    40
     prerequisites lists (both).
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    41
     If empty, everything that is found along the inheritance of any of
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    42
     my classes is considered to be a prerequisite package."
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    43
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    44
    ^ #(
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    45
    )
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    46
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    47
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    48
mandatoryPreRequisites
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    49
    "list packages which are mandatory as a prerequisite.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    50
     This are packages containing superclasses of my classes and classes which
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    51
     are extended by myself.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    52
     They are mandatory, because we need these packages as a prerequisite for loading and compiling.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    53
     This method is generated automatically,
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    54
     by searching along the inheritance chain of all of my classes.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    55
     Please take a look at the #referencedPreRequisites method as well."
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    56
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    57
    ^ #(
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    58
        #'stx:libbasic'    "LibraryDefinition - superclass of stx_libscm_gitHub"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    59
    )
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    60
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    61
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    62
referencedPreRequisites
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    63
    "list packages which are a prerequisite, because they contain
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    64
     classes which are referenced by my classes.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    65
     These packages are NOT needed as a prerequisite for compiling or loading,
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    66
     however, a class from it may be referenced during execution and having it
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    67
     unloaded then may lead to a runtime doesNotUnderstand error, unless the caller
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    68
     includes explicit checks for the package being present.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    69
     This method is generated automatically,
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    70
     by searching all classes (and their packages) which are referenced by my classes.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    71
     Please also take a look at the #mandatoryPreRequisites method"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    72
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    73
    ^ #(
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    74
        #'stx:goodies/communication'    "JSONReader - referenced by GitHubSmalltalkClassReader>>readClass"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    75
        #'stx:libbasic3'    "ChangeSet - referenced by GitHubSmalltalkClassReader>>addChange:"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    76
        #'stx:libcomp'    "Parser - referenced by GitHubSmalltalkClassReader>>readMethodFrom:forClassNamed:"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    77
    )
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    78
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    79
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    80
subProjects
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    81
    "list packages which are known as subprojects.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    82
     The generated makefile will enter those and make there as well.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    83
     However: they are not forced to be loaded when a package is loaded;
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    84
     for those, redefine #referencedPrerequisites or #mandatoryPreRequisites."
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    85
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    86
    ^ #(
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    87
    )
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    88
! !
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    89
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    90
!stx_libscm_gitHub class methodsFor:'description - contents'!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    91
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    92
classNamesAndAttributes
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    93
    "lists the classes which are to be included in the project.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    94
     Each entry in the list may be: a single class-name (symbol),
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    95
     or an array-literal consisting of class name and attributes.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    96
     Attributes are: #autoload or #<os> where os is one of win32, unix,..."
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    97
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    98
    ^ #(
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
    99
        "<className> or (<className> attributes...) in load order"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   100
        GitHubSmalltalkClassReader
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   101
        GitHubSmalltalkPackageReader
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   102
        #'stx_libscm_gitHub'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   103
    )
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   104
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   105
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   106
extensionMethodNames
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   107
    "lists the extension methods which are to be included in the project.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   108
     Entries are 2-element array literals, consisting of class-name and selector.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   109
     A correponding method with real names must be present in my concrete subclasses
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   110
     if it has extensions."
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   111
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   112
    ^ #(
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   113
    )
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   114
! !
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   115
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   116
!stx_libscm_gitHub class methodsFor:'description - project information'!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   117
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   118
companyName
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   119
    "Returns a company string which will appear in <lib>.rc.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   120
     Under win32, this is placed into the dll's file-info.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   121
     Other systems may put it elsewhere, or ignore it."
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   122
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   123
    ^ 'Claus Gittinger & eXept Software AG'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   124
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   125
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   126
description
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   127
    "Returns a description string which will appear in nt.def / bc.def"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   128
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   129
    ^ 'Smalltalk/X Class library'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   130
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   131
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   132
legalCopyright
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   133
    "Returns a copyright string which will appear in <lib>.rc.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   134
     Under win32, this is placed into the dll's file-info.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   135
     Other systems may put it elsewhere, or ignore it."
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   136
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   137
    ^ 'Copyright Claus Gittinger 2018\nCopyright eXept Software AG 2018'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   138
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   139
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   140
productName
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   141
    "Returns a product name which will appear in <lib>.rc.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   142
     Under win32, this is placed into the dll's file-info.
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   143
     This method is usually redefined in a concrete application definition"
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   144
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   145
    ^ 'Smalltalk/X'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   146
! !
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   147
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   148
!stx_libscm_gitHub class methodsFor:'documentation'!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   149
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   150
version
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   151
    ^ '$Header$'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   152
!
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   153
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   154
version_CVS
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   155
    ^ '$Header$'
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   156
! !
eec6475ab243 initial checkin
Claus Gittinger <cg@exept.de>
parents:
diff changeset
   157