|
1 # |
|
2 # Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved. |
|
3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 # |
|
5 # This code is free software; you can redistribute it and/or modify it |
|
6 # under the terms of the GNU General Public License version 2 only, as |
|
7 # published by the Free Software Foundation. Oracle designates this |
|
8 # particular file as subject to the "Classpath" exception as provided |
|
9 # by Oracle in the LICENSE file that accompanied this code. |
|
10 # |
|
11 # This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 # version 2 for more details (a copy is included in the LICENSE file that |
|
15 # accompanied this code). |
|
16 # |
|
17 # You should have received a copy of the GNU General Public License version |
|
18 # 2 along with this work; if not, write to the Free Software Foundation, |
|
19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 # |
|
21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 # or visit www.oracle.com if you need additional information or have any |
|
23 # questions. |
|
24 # |
|
25 |
|
26 help.set.format = \ |
|
27 Set the format for reporting a snippet event.\n\ |
|
28 \n\ |
|
29 /set format <mode> <field> "<format>" <selector>...\n\ |
|
30 \n\ |
|
31 Where <mode> is the name of a previously defined feedback mode -- see '/help /set newmode'.\n\ |
|
32 Where <field> is the name of context-specific format to define.\n\ |
|
33 Where <format> is a quoted string which will be the value of the field if one of\n\ |
|
34 the selectors matches (or there are no selectors). When the format is used,\n\ |
|
35 field names enclosed in braces are replaced with the value of the field at that\n\ |
|
36 time. These fields may have been previously defined with this command or may be\n\ |
|
37 one of these predefined fields specific to the context:\n\t\ |
|
38 {name} == The name, e.g.: the variable name, ...\n\t\ |
|
39 {type} == The type name. The type of a variable or expression, the\n\t\t\t\ |
|
40 parameter types of a method\n\t\ |
|
41 {value} == The result value of an expression or variable initialization\n\t\ |
|
42 {unresolved} == The list of unresolved references\n\t\ |
|
43 {errors} == The list of recoverable errors (during the processing of the\n\t\t\t\ |
|
44 "display" field only)\n\t\ |
|
45 {err} == An unformatted error line (during the processing of the\n\t\t\t\ |
|
46 "errorline" field only)\n\ |
|
47 The following fields are accessed by the tool to determine the displayed feedback:\n\t\ |
|
48 {display} == The displayed message for a snippet event\n\t\ |
|
49 {errorline} == The format of one error line within the "errors" field\n\t\ |
|
50 {pre} == The feedback prefix (begins command feedback)\n\t\ |
|
51 {post} == The feedback postfix (ends command feedback)\n\t\ |
|
52 {errorpre} == The error prefix (begins error feedback)\n\t\ |
|
53 {errorpost} == The error postfix (ends error feedback)\n\ |
|
54 These fields have default settings (which may be overwritten).\n\ |
|
55 Where <selector> is the context in which the format is applied.\n\ |
|
56 The structure of selector is a hyphen separated list of selector kind lists.\n\ |
|
57 A selector kind list is a comma separated list of values of one selector kind.\n\ |
|
58 A selector matches if each selector kind list matches; A selector kind list\n\ |
|
59 matches if one of the values matches.\n |
|
60 help.set.format.case = The case selector kind describes the kind of snippet. The values are:\n |
|
61 help.set.format.action = The action selector kind describes what happened to the snippet. The values are:\n |
|
62 help.set.format.when = The when-did-it-occur selector kind describes if this is a direct or indirect action. The values are:\n |
|
63 help.set.format.resolve = The resolution-state selector kind describes the state of resolution/definition of the snippet. The values are:\n |
|
64 help.set.format.unresolved = The unresolved-count selector kind describes the number of unresolved references. The values are:\n |
|
65 help.set.format.errors = The errors-count selector kind describes the number of errors. The values are:\n |
|
66 help.set.format.end = \n\ |
|
67 Examples:\n\t\ |
|
68 /set format myformat action 'Created' added-primary\n\t\ |
|
69 /set format myformat action 'Update replaced' replaced-update\n\t\ |
|
70 /set format myformat display '{pre}{action} class {name}{post}' class-ok\n\t\ |
|
71 /set format myformat display '{pre}{action} variable {name}, reset to null{post}' replaced-vardecl,varinit-ok-update\n\n\ |
|
72 Note that subsequent selectors for a field may overwrite some or all of previous used selectors -- last one wins\n |
|
73 |
|
74 help.set.feedback = \ |
|
75 Set the feedback mode describing displayed feedback for entered snippets and commands.\n\ |
|
76 \n\ |
|
77 /set feedback <mode>\n\ |
|
78 \n\ |
|
79 Where <mode> is the name of a previously defined feedback mode.\n\ |
|
80 You may use just enough letters to make it unique.\n\ |
|
81 User-defined modes can be added, see '/help /set newmode'\n\ |
|
82 Currently defined feedback modes:\n |
|
83 |
|
84 help.set.newmode = \ |
|
85 Create a user-defined feedback mode, optionally copying from an existing mode.\n\ |
|
86 \n\ |
|
87 /set newmode <new-mode> [command|quiet [<old-mode>]]\n\ |
|
88 \n\ |
|
89 Where <new-mode> is the name of a mode you wish to create.\n\ |
|
90 Where <old-mode> is the name of a previously defined feedback mode.\n\ |
|
91 If <old-mode> is present, its settings are copied to the new mode.\n\ |
|
92 'command' vs 'quiet' determines if informative/verifying command feedback is displayed.\n\ |
|
93 \n\ |
|
94 Once the new mode is created, use '/set format' and '/set prompt' to configure it.\n\ |
|
95 Use '/set feedback' to use the new mode.\n\ |
|
96 |
|
97 help.set.prompt = \ |
|
98 Set the prompts. Both the normal prompt and the continuation-prompt must be set.\n\ |
|
99 \n\ |
|
100 /set prompt <mode> \"<prompt>\" \"<continuation-propmt>\"\n\ |
|
101 \n\ |
|
102 Where <mode> is the name of a previously defined feedback mode.\n\ |
|
103 Where <prompt> and <continuation-propmt> are quoted strings printed as input prompts;\n\ |
|
104 Both may optionally contain '%s' which will be substituted with the next snippet id --\n\ |
|
105 note that what is entered may not be assigned that id, for example it may be an error or command.\n\ |
|
106 The continuation-prompt is used on the second and subsequent lines of a multi-line snippet.\n |
|
107 |
|
108 startup.feedback = \ |
|
109 /set newmode normal command \n\ |
|
110 /set prompt normal '\\n-> ' '>> ' \n\ |
|
111 /set format normal pre '| ' \n\ |
|
112 /set format normal post '%n' \n\ |
|
113 /set format normal errorpre '| ' \n\ |
|
114 /set format normal errorpost '%n' \n\ |
|
115 \n\ |
|
116 /set format normal errorline '{post}{pre} {err}' \n\ |
|
117 \n\ |
|
118 /set format normal action 'Added' added-primary \n\ |
|
119 /set format normal action 'Modified' modified-primary \n\ |
|
120 /set format normal action 'Replaced' replaced-primary \n\ |
|
121 /set format normal action 'Overwrote' overwrote-primary \n\ |
|
122 /set format normal action 'Dropped' dropped-primary \n\ |
|
123 /set format normal action ' Update added' added-update \n\ |
|
124 /set format normal action ' Update modified' modified-update \n\ |
|
125 /set format normal action ' Update replaced' replaced-update \n\ |
|
126 /set format normal action ' Update overwrote' overwrote-update \n\ |
|
127 /set format normal action ' Update dropped' dropped-update \n\ |
|
128 \n\ |
|
129 /set format normal until ', however, it cannot be instanciated or its methods invoked until' defined-class-primary \n\ |
|
130 /set format normal until ', however, its methods cannot be invoked until' defined-interface-primary \n\ |
|
131 /set format normal until ', however, it cannot be used until' defined-enum,annotation-primary \n\ |
|
132 /set format normal until ', however, it cannot be invoked until' defined-method-primary \n\ |
|
133 /set format normal until ', however, it cannot be referenced until' notdefined-primary \n\ |
|
134 /set format normal until ' which cannot be instanciated or its methods invoked until' defined-class-update \n\ |
|
135 /set format normal until ' whose methods cannot be invoked until' defined-interface-update \n\ |
|
136 /set format normal until ' which cannot be invoked until' defined-method-update \n\ |
|
137 /set format normal until ' which cannot be referenced until' notdefined-update \n\ |
|
138 \n\ |
|
139 /set format normal unrerr '{unresolved} is declared' unresolved1-error0 \n\ |
|
140 /set format normal unrerr '{unresolved} are declared' unresolved2-error0 \n\ |
|
141 /set format normal unrerr ' this error is corrected: {errors}' unresolved0-error1 \n\ |
|
142 /set format normal unrerr '{unresolved} is declared and this error is corrected: {errors}' unresolved1-error1 \n\ |
|
143 /set format normal unrerr '{unresolved} are declared and this error is corrected: {errors}' unresolved2-error1 \n\ |
|
144 /set format normal unrerr ' these errors are corrected: {errors}' unresolved0-error2 \n\ |
|
145 /set format normal unrerr '{unresolved} is declared and these errors are corrected: {errors}' unresolved1-error2 \n\ |
|
146 /set format normal unrerr '{unresolved} are declared and these errors are corrected: {errors}' unresolved2-error2 \n\ |
|
147 \n\ |
|
148 /set format normal resolve '{until}{unrerr}' added,modified,replaced,used \n\ |
|
149 \n\ |
|
150 /set format normal typeKind 'class' class \n\ |
|
151 /set format normal typeKind 'interface' interface \n\ |
|
152 /set format normal typeKind 'enum' enum \n\ |
|
153 /set format normal typeKind 'annotation interface' annotation \n\ |
|
154 \n\ |
|
155 /set format normal display '{pre}{action} {typeKind} {name}{resolve}{post}' class,interface,enum,annotation \n\ |
|
156 /set format normal display '{pre}{action} method {name}({type}){resolve}{post}' method \n\ |
|
157 \n\ |
|
158 /set format normal display '{pre}{action} variable {name} of type {type}{resolve}{post}' vardecl \n\ |
|
159 /set format normal display '{pre}{action} variable {name} of type {type} with initial value {value}{resolve}{post}' varinit \n\ |
|
160 /set format normal display '{pre}{action} variable {name}, reset to null{post}' replaced-vardecl,varinit-ok-update \n\ |
|
161 /set format normal display '{pre}{action} variable {name}{resolve}{post}' vardecl,varinit-notdefined \n\ |
|
162 /set format normal display '{pre}{action} variable {name}{post}' overwrote,dropped-vardecl,varinit \n\ |
|
163 \n\ |
|
164 /set format normal display '{pre}Expression value is: {value}{post}{pre} assigned to temporary variable {name} of type {type}{post}' expression \n\ |
|
165 /set format normal display '{pre}Variable {name} of type {type} has value {value}{post}' varvalue \n\ |
|
166 /set format normal display '{pre}Variable {name} has been assigned the value {value}{post}' assignment \n\ |
|
167 \n\ |
|
168 /set format normal display '{pre}Attempted to use {typeKind} {name}{resolve}{post}' used-class,interface,enum,annotation \n\ |
|
169 /set format normal display '{pre}Attempted to call method {name}({type}){resolve}{post}' used-method \n\ |
|
170 \n\ |
|
171 /set feedback normal \n\ |
|
172 \n\ |
|
173 /set newmode off quiet \n\ |
|
174 /set prompt off '-> ' '>> ' \n\ |
|
175 /set format off pre '| ' \n\ |
|
176 /set format off post '%n' \n\ |
|
177 /set format off errorpre '| ' \n\ |
|
178 /set format off errorpost '%n' \n\ |
|
179 /set format off display '' \n |