Warning.st
author Claus Gittinger <cg@exept.de>
Wed, 14 Oct 2009 19:34:52 +0200
changeset 12279 a76ac48afbdf
parent 12083 079b2535924f
child 16423 d14faa326453
child 18011 deb0c3355881
permissions -rw-r--r--
changed: #documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4466
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     1
"
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     2
 COPYRIGHT (c) 1999 by eXept Software AG
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     3
              All Rights Reserved
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     4
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     5
 This software is furnished under a license and may be used
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     6
 only in accordance with the terms of that license and with the
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     8
 be provided or otherwise made available to, or used by, any
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
     9
 other person.  No title to or ownership of the software is
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    10
 hereby transferred.
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    11
"
6206
59d1ec1e1ed5 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 5295
diff changeset
    12
"{ Package: 'stx:libbasic' }"
59d1ec1e1ed5 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 5295
diff changeset
    13
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
    14
UserNotification subclass:#Warning
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    15
	instanceVariableNames:''
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    16
	classVariableNames:''
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    17
	poolDictionaries:''
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    18
	category:'Kernel-Exceptions'
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    19
!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    20
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    21
!Warning class methodsFor:'documentation'!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    22
4466
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    23
copyright
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    24
"
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    25
 COPYRIGHT (c) 1999 by eXept Software AG
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    26
              All Rights Reserved
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    27
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    28
 This software is furnished under a license and may be used
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    29
 only in accordance with the terms of that license and with the
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    30
 inclusion of the above copyright notice.   This software may not
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    31
 be provided or otherwise made available to, or used by, any
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    32
 other person.  No title to or ownership of the software is
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    33
 hereby transferred.
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    34
"
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    35
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    36
!
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    37
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    38
documentation
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    39
"
12279
a76ac48afbdf changed: #documentation
Claus Gittinger <cg@exept.de>
parents: 12083
diff changeset
    40
    Warning is the superclass of all warning signals in the system.
7038
89e892bb8226 Documentation
Stefan Vogel <sv@exept.de>
parents: 7032
diff changeset
    41
    The default beavior for an unhandled Warning is to display a warn
89e892bb8226 Documentation
Stefan Vogel <sv@exept.de>
parents: 7032
diff changeset
    42
    box with the error decription. If no display is available, the error 
89e892bb8226 Documentation
Stefan Vogel <sv@exept.de>
parents: 7032
diff changeset
    43
    description is written to the Transcript.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    44
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    45
    [author:]
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    46
        Stefan Vogel
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    47
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    48
    [see also:]
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    49
        Signal
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    50
"
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    51
!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    52
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    53
examples
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    54
"
6427
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    55
  show a warning:
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    56
                                                            [exBegin]
6427
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    57
    Transcript showCR:'1 - now raising'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    58
    Warning raiseRequest.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    59
    Transcript showCR:'2 - after the raise'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    60
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    61
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    62
  passing an errorString:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    63
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    64
    Warning raiseRequestErrorString:'hello world'
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    65
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    66
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    67
  provide a handler for warnings:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    68
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    69
    Warning handle:[:ex |
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    70
        Transcript showCR:'WARNING: ' , ex description
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    71
    ] do:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    72
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    73
        Warning raiseRequest.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    74
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    75
    ].
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    76
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    77
    Warning handle:[:ex |
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    78
        Transcript showCR:'WARNING: ' , ex description
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    79
    ] do:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    80
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    81
        Warning raiseRequestErrorString:'hello world'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    82
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    83
    ]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    84
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    85
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    86
  ignore warnings during some evaluation:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    87
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    88
    Warning ignoreIn:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    89
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    90
        Warning raiseRequest.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    91
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    92
    ]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    93
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    94
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    95
  defer a warning to some later time:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    96
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    97
    Warning deferAfter:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    98
        Transcript showCR:'1 - no warning here ...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    99
        Warning raiseRequestErrorString:'this warning is deferred'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   100
        Transcript showCR:'2 - but in a second...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   101
    ].
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   102
    Transcript showCR:'3 - after warning-protected block'.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   103
                                                            [exEnd]
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   104
"
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   105
! !
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   106
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   107
!Warning class methodsFor:'initialization'!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   108
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   109
initialize
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   110
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   111
    NotifierString := 'Warning:'.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   112
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   113
    "
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   114
     self initialize
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   115
    "
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   116
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   117
    "Created: / 23.7.1999 / 15:34:27 / stefan"
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   118
! !
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   119
12083
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   120
!Warning class methodsFor:'misc ui support'!
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   121
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   122
iconInBrowserSymbol
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   123
    <resource: #programImage>
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   124
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   125
    ^ #warningClassBrowserIcon
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   126
! !
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   127
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   128
!Warning methodsFor:'default actions'!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   129
4525
999e680a29ca Make error classes public.
Stefan Vogel <sv@exept.de>
parents: 4508
diff changeset
   130
defaultAction
5295
f144309dab04 #errorString --> #description
Stefan Vogel <sv@exept.de>
parents: 4525
diff changeset
   131
    "Default action for warnings: open a warn box with description"
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   132
4500
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   133
    |text|
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   134
5295
f144309dab04 #errorString --> #description
Stefan Vogel <sv@exept.de>
parents: 4525
diff changeset
   135
    text := self description.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   136
10517
160835ef7978 changed #defaultAction - use #hasDialog
Stefan Vogel <sv@exept.de>
parents: 8681
diff changeset
   137
    self hasDialog ifTrue:[
4500
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   138
        Dialog warn:text.
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   139
    ] ifFalse:[
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   140
        "
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   141
         on systems without GUI, simply show
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   142
         the message on the Transcript.
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   143
        "
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   144
        Transcript show:'warning: '; showCR:text.
4500
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   145
    ].
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   146
    self proceed.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   147
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   148
    "
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   149
      Warning raiseRequestErrorString:' abc'
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   150
    "
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   151
4508
d64471bf34af No need to autoload.
Stefan Vogel <sv@exept.de>
parents: 4500
diff changeset
   152
    "Modified: / 3.8.1999 / 14:06:41 / stefan"
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   153
! !
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   154
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   155
!Warning class methodsFor:'documentation'!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   156
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   157
version
12279
a76ac48afbdf changed: #documentation
Claus Gittinger <cg@exept.de>
parents: 12083
diff changeset
   158
    ^ '$Header: /cvs/stx/stx/libbasic/Warning.st,v 1.14 2009-10-14 17:34:52 cg Exp $'
12083
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   159
!
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   160
079b2535924f *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 10517
diff changeset
   161
version_CVS
12279
a76ac48afbdf changed: #documentation
Claus Gittinger <cg@exept.de>
parents: 12083
diff changeset
   162
    ^ '$Header: /cvs/stx/stx/libbasic/Warning.st,v 1.14 2009-10-14 17:34:52 cg Exp $'
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   163
! !
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   164
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   165
Warning initialize!