Warning.st
author Stefan Vogel <sv@exept.de>
Thu, 20 Jan 2005 13:26:20 +0100
changeset 8681 38aa963476a5
parent 7038 89e892bb8226
child 10517 160835ef7978
permissions -rw-r--r--
Support for Block>>#on:do:on:do:
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
"
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    12
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    13
6206
59d1ec1e1ed5 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 5295
diff changeset
    14
"{ Package: 'stx:libbasic' }"
59d1ec1e1ed5 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 5295
diff changeset
    15
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
    16
UserNotification subclass:#Warning
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    17
	instanceVariableNames:''
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    18
	classVariableNames:''
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    19
	poolDictionaries:''
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    20
	category:'Kernel-Exceptions'
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    21
!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    22
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    23
!Warning class methodsFor:'documentation'!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    24
4466
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    25
copyright
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    26
"
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    27
 COPYRIGHT (c) 1999 by eXept Software AG
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    28
              All Rights Reserved
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    29
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    30
 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
    31
 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
    32
 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
    33
 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
    34
 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
    35
 hereby transferred.
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
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    38
!
9cba6f4ecec4 copyrights added; typo in docu
Claus Gittinger <cg@exept.de>
parents: 4446
diff changeset
    39
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    40
documentation
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    41
"
7038
89e892bb8226 Documentation
Stefan Vogel <sv@exept.de>
parents: 7032
diff changeset
    42
    Warning is the superclass of all warning exceptions in the system.
89e892bb8226 Documentation
Stefan Vogel <sv@exept.de>
parents: 7032
diff changeset
    43
    The default beavior for an unhandled Warning is to display a warn
89e892bb8226 Documentation
Stefan Vogel <sv@exept.de>
parents: 7032
diff changeset
    44
    box with the error decription. If no display is available, the error 
89e892bb8226 Documentation
Stefan Vogel <sv@exept.de>
parents: 7032
diff changeset
    45
    description is written to the Transcript.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    46
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    47
    [author:]
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    48
        Stefan Vogel
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    49
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    50
    [see also:]
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    51
        Signal
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    52
"
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    53
!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    54
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    55
examples
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    56
"
6427
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    57
  show a warning:
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
    58
                                                            [exBegin]
6427
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    59
    Transcript showCR:'1 - now raising'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    60
    Warning raiseRequest.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    61
    Transcript showCR:'2 - after the raise'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    62
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    63
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    64
  passing an errorString:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    65
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    66
    Warning raiseRequestErrorString:'hello world'
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    67
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    68
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    69
  provide a handler for warnings:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    70
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    71
    Warning handle:[:ex |
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    72
        Transcript showCR:'WARNING: ' , ex description
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    73
    ] do:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    74
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    75
        Warning raiseRequest.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    76
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    77
    ].
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    78
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    79
    Warning handle:[:ex |
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    80
        Transcript showCR:'WARNING: ' , ex description
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    81
    ] do:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    82
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    83
        Warning raiseRequestErrorString:'hello world'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    84
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    85
    ]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    86
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    87
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    88
  ignore warnings during some evaluation:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    89
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    90
    Warning ignoreIn:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    91
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    92
        Warning raiseRequest.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    93
        '...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    94
    ]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    95
                                                            [exEnd]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    96
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    97
  defer a warning to some later time:
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    98
                                                            [exBegin]
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
    99
    Warning deferAfter:[
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   100
        Transcript showCR:'1 - no warning here ...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   101
        Warning raiseRequestErrorString:'this warning is deferred'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   102
        Transcript showCR:'2 - but in a second...'.
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   103
    ].
890d7bd17cce documentation
Claus Gittinger <cg@exept.de>
parents: 6206
diff changeset
   104
    Transcript showCR:'3 - after warning-protected block'.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   105
                                                            [exEnd]
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   106
"
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   107
! !
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   108
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   109
!Warning class methodsFor:'initialization'!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   110
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   111
initialize
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   112
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   113
    NotifierString := 'Warning:'.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   114
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   115
    "
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   116
     self initialize
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   117
    "
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   118
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   119
    "Created: / 23.7.1999 / 15:34:27 / stefan"
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   120
! !
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   121
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   122
!Warning methodsFor:'default actions'!
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   123
4525
999e680a29ca Make error classes public.
Stefan Vogel <sv@exept.de>
parents: 4508
diff changeset
   124
defaultAction
5295
f144309dab04 #errorString --> #description
Stefan Vogel <sv@exept.de>
parents: 4525
diff changeset
   125
    "Default action for warnings: open a warn box with description"
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   126
4500
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   127
    |text|
be0fe7e7e21b Write to transcript if Dialog is not available.
Stefan Vogel <sv@exept.de>
parents: 4466
diff changeset
   128
5295
f144309dab04 #errorString --> #description
Stefan Vogel <sv@exept.de>
parents: 4525
diff changeset
   129
    text := self description.
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   130
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   131
    (Smalltalk isInitialized 
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   132
     and:[Dialog notNil
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   133
     and:[Screen notNil
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   134
     and:[Screen current notNil
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   135
     and:[Screen current isOpen
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   136
    ]]]]) ifTrue:[
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   137
        Dialog autoload.        "in case its autoloaded"
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
8681
38aa963476a5 Support for Block>>#on:do:on:do:
Stefan Vogel <sv@exept.de>
parents: 7038
diff changeset
   158
    ^ '$Header: /cvs/stx/stx/libbasic/Warning.st,v 1.11 2005-01-20 12:25:49 stefan Exp $'
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   159
! !
7032
3c0246b4e602 Now Warning is a subclass of UserNotification.
Stefan Vogel <sv@exept.de>
parents: 6427
diff changeset
   160
4446
4da4e51fc1ab initial checkin
Stefan Vogel <sv@exept.de>
parents:
diff changeset
   161
Warning initialize!