-
Notifications
You must be signed in to change notification settings - Fork 4
/
orglike-headline.gms
1196 lines (835 loc) · 36.5 KB
/
orglike-headline.gms
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
$title A sample file for showing Org-mode feature in GAMS mode
*@ A sample file for showing Org-mode feature in GAMS mode
$ontext
First-written: <2012/07/25>
$offtext
*@@ [Org mode like headline representation]
$ontext
In GAMS mode, you can use outline representation like Org-mode (or outline
mode). This is a sample file for explaining this feature.
By default, lines starting with `*@` are regarded as headlines.
*@ The top level headline
*@@ Second level
text text
*@@@ Third level
text text
*@ Another top level headline
You can change outline representation by the following two commands:
+ `gams-orglike-cycle` (binded to TAB key)
+ `gams-orglike-global-cycle` (binded to Shift+TAB key).
`gams-orglike-cycle` command works only on headlines and toggles hide/show the
body of programs. `gams-orglike-global-cycle` toggles hide/show entire program.
Try TAB and Shift+TAB.
This feature uses codes in outline-mode (although we use term `orglike', this
feature do not use codes in `org-mode').
$offtext
*@@ [How to change symbols for headlines]
$ontext
In the default setting, "*@" is used as symbols to represent headlines. This is
determined by the lisp variable `gams-outline-regexp`. This variable specifies
the regular expressions of the symbol used to represent headlines and its
default value is
"\\*@+[ \t]"
If you change the value of this variable, you can change symbols for
headlines. For example, add the following expression to your init.el file
(setq gams-outline-regexp "[ \t]*display \"@+[ \t]")
and open "orglike-headline-alt.gms".
$offtext
*@@ [Other commands for outline handling]
$ontext
+ "C-cC-:n" -> Move to the next headlines (`outline-next-visible-heading`).
+ "C-cC-:p" -> Move to the previous headlines (`outline-previous-visible-heading`).
+ "C-cC-:f" -> Fold the current tree (`outline-hide-leaves`).
+ "C-cC-:k" -> Show branches (`outline-show-branches`).
(setq gams-outline-regexp "\\*@+[ \t]")
(setq gams-outline-regexp-font-lock "^\\([*]\\@*\\)\\(\\@[ \t]\\)\\(.*\\)")
$offtext
* ----------------------------------------------------------------------
*@ Keybindings
* ----------------------------------------------------------------------
* TAB: gams-orglike-cycle
* Shift + TAB: gams-orglike-global-cycle
* Try to type TAB and SHIFT+TAB!!!
* ----------------------------------------------------------------------
*@ Specification of lst file or lst file directory (sample code):
* ----------------------------------------------------------------------
$ontext
To activiate lst file specification, remove one of two asterisks at the
beginning of the line.
$offtext
** gams-lst-file: ./lst/lst-sample.lst
* The above code means that lst file -> ./lst/lst-sample.lst:
** gams-lst-file: g:/lst-sample.lst
* The above code means that lst file -> g:/lst-sample.lst:
** gams-lst-dir: ./lst/
* The above code means that lst file -> ./lst/gams-sample.lst
** gams-lst-dir: g:/
* The above code means that lst file -> g:/gams-sample.lst
$ontext
Commentary:
* For gams-mode.el version 6.7.
* Notations like "C-cC-v" follow the Emacs convention. For example,
`C-cC-v' -> Type "Control key + c" and then type "Control + v" key.
`M-q' -> Type "Meta (or Alt) key + q".
* You can see the explanation of variables and commands by M-x
describe-variable and M-x describe-function respectively.
* Bug reports, requests, and suggestions are all welcome! If you find bugs,
please use M-x gams-report-bug.
$offtext
* Inline comment symbol
$inlinecom /* */
* End-of-line comment symbol
$eolcom #
* The name of the included program file.
$setglobal sub_program ./include/include-sample.gms
$ontext
If your setting is proper, this buffer must be in GAMS mode (if the mode line
contains the string "GAMS", you are in GAMS mode). If you are not in GAMS mode,
please check your configuration in "~/.emacs.d/init.el" (in particular,
load-path setting).
$offtext
* ----------------------------------------------------------------------
*@ Basic usage.
* ----------------------------------------------------------------------
$ontext
First, try to run GAMS on this file. Type `C-cC-t', then you see the following
message in the echo are (mini-buffer).
Start GAMS (s), Kill GAMS process (k), Change GAMS command (c), Change options (o).
Type `s', and GAMS will start. Or if you type F9 key or `C-cC-s', GAMS will
directly start.
[Note] if GAMS does not start or does not work well, there are likely to be some
problems in configurations. Please check the following:
+ Does a shell (such as cmdproxy or bash) work properly in your Emacs?
+ Check the setting of the variable `gams-process-command-name'. If you do not
include the GAMS system directory in the environmental variable PATH, you
must set the full path to GAMS to `gams-process-command-name'.
When the GAMS process finishes, type `C-cC-v' or F10 key to switch to the LST
file buffer.
In the LST buffer, you will see a message "No error message is found" in the
echo are. This message means that this gms file was executed successfully
without any error.
Type `i' (or `b') to jump back to the gms file buffer.
Next, uncomment the following line (delete * before "Uncommen this ..." line)
and run GAMS (type `C-cC-t' and type `s').
$offtext
* Uncomment this line. Error is here.
$ontext
Then, you will see the following message in the echo are
GAMS ended with 'Compilation' errors! C-cC-v or [F10]= LST file.
Switch to the LST buffer (C-cC-v or f10) and you will see two windows and the
following message in the echo are.
LastMod 2021/02/24 10:37:40: [u]=Jump to the error place, [i]=Jump to the main input file
and you see the following message in the LST buffer
105 Uncomment this line. Error is here.
**** $140 $36 $342 $342
**** 36 '=' or '..' or ':=' or '$=' operator expected
**** rest of statement ignored
**** 140 Unknown symbol
**** 342 Illegal suffix syntax - has to start with a letter
Note that when you encounter errors in GAMS, you should see the _first_ error.
In this case, the first error is the error of number $140. This is a typical
syntax error message in LST files, namely, "Unknown symbol" error. This means
that you use the symbol not defined (declared) before.
The above message also shows the line with the error in the gms buffer, that is,
105.
If you type `y' in the LST file buffer, you can go to the first error place from
anywhere in the buffer. Try it.
Next, type `u' in the LST buffer and you will jump back to the error line in the
program file buffer.
Repeating the same procedure
o Run GAMS (`F9' or `C-cC-s').
o Switch to LST buffer (`F10' or `C-cC-v').
o See the error line and its meaning.
o Jump back to the error line in the program file buffer (`u')
you can easily debug your GMS file.
[Note] The difference between `u' and `i' (or `b').
If an error exists, the following message will appear in the echo are.
[u]=Jump to the error place, [i]=Jump to the main input file
If there is only one program file, you had better type `u'. But there may be
many program files if you use $INCLUDE etc. and errors may be included in
subroutine files. In this case, you may want to jump to the main input file
instead of the subroutine file with the error. Then you had better type `i'
instead of `u'.
`u' = Jump to the error place
==> Jump to the file where the error exists (it may be a subroutine file).
`i' (or `b') = Jump to the main input file.
==> The main input file is the top level program file (its name is taken from
the FILE SUMMARY field in the LST file.)
When you encounter another types of errors, only the error line may be
displayed. For example, uncomment the line "* b = 1/a;" below (delete
*) and run GAMS and type `C-cC-v'.
$offtext
parameter a Parameter a
b Parameter b
;
a = 0;
* b = 1/a; # Uncomment this line.
parameter c, d, e;
$ontext
Type `l' on the following error line
*** Exec Error at line 185: division by zero (0)
then you will jump to the error line (185). Moreover, type `b' and you jump to
the GMS file.
$offtext
* ----------------------------------------------------------------------
*@ Other commands in GAMS mode.
* ----------------------------------------------------------------------
* ---------------------------------------------------------
*@ Process handling.
* ---------------------------------------------------------
*@@ [Running GAMS and editing a command line.]
$ontext
As described above, you can start GAMS process by typing `C-cC-ts' (or F9).
Moreover, if you attach the universal argument (i.e. C-u), you are able to edit
the command line before starting process.
If you type `C-uC-cC-t', you see
Start GAMS (s), Kill GAMS process (k), Change GAMS command (c), Change options (o).
If you type `s' here, you encounter a message like
Edit command if you want: gams gams-sample.gms
and you can edit the command line. Moreover, when you edit the command line,
you are asked to use it in the future like this.
Use this command line also in the future?
If you answer `y' to this, the following line will be inserted in the first line
of this file.
*#!gams gams-sample.gms ll=0 lo=3 pw=95
When you evoke GAMS on this file next time, this line is passed to the shell as
the command line. If you want to restore the default command line, just delete
this line.
$offtext
*@@ [Specify a command line by *#! notation]
$ontext
When there is a line beginning with *#! on the first line in a GMS file, GAMS
mode uses its content as a command line. For example, suppose that you write
the following statement in the first line
*#!c:/GAMS/win64/24.6/gams.exe gams-sample.gms ll=0 lo=3 pw=100 o=./gams-sample-alt.lst
Then,
c:/GAMS/win64/24.6/gams.exe gams-sample.gms ll=0 lo=3 pw=100 o=./gams-sample-alt.lst
is executed as a command line. This is a function like #!/usr/bin/perl or
#!/bin/sh for shell scripts. By default, the command line is determined by
`gams-process-command-name' and `gams-process-command-option' and it is common
to all GMS files. But when you want to use a different command line for a
specific file, use this *#! notation.
$offtex
*@@ [Kill (stop) the GAMS process.]
$ontext
If you type `k' when a GAMS process is running, you can kill (stop) the process.
Uncomment the following programs and try them.
(1) `C-cC-t'
(2) `s'
(3) `C-cC-t' while a GAMS process running.
(4) `k'
To uncomment a ontext-oftext pair, type `C-cM-c' on ontext or offtext.
$offtext
$ontext
* Type `C-cM-c' on the above ontext! To comment out them, type
* the same.
set o /o1*o10000000/;
parameter
xx(o)
yy(o)
;
xx("o1") = 0;
loop(o,
yy(o) = sin(xx(o));
xx(o+1) = 0.1 + xx(o);
);
display yy;
$offtext
*@@ [Change command line options.]
$ontext
If you type `o' in the process menu, you can change and register a new command
line option combiantion. Registered option combiantion is stored in the
variable `gams-user-option-alist' and saved in the file decided by the variable
`gams-statement-file'.
The default option combiantion is determinied by the value of
`gams-process-command-option'.
$offtext
*@@ [Change gams command.]
$ontext
If you type `c' in the process menu, you can change (and register) alternative
GAMS commands. You can set the default GAMS pcommand by the value of
`gams-process-command-name'. But you may often want to use gams.exe of different
versions. In such cases, register other gams.exe by this menu.
$offtext
*@@@ test
* The third level.
*@@@ test2
* The third level.
*@@@@ 4th level
*@@@@@ 5th level
* ---------------------------------------------------------
*@ Specify the place and name of the LST file.
* ---------------------------------------------------------
$ontext
When you run GAMS on a gms file, GAMS creates the LST file with the same name in
the same directory. However, you can specify the name and place of the LST file
explicitly.
For example, if you want to let `lst-sample.lst' be the name of the LST file
corresponding to this gams-sample.gms and put it in the subdirectory `lst'.
Then, add the following code somewhere in this file:
* gams-lst-file: ./lst/lst-sample.lst
(Note that * must really be on the beginning of line)
This code has two effects
1) gams is executed with option 'o=./lst/lst-sample.lst'
2) You can switch from the gms file to ./lst/lst-sample.lst by C-cC-v (or
F10).
If you want to try this, please delete one `*' in the gams-lst-file line of this
file and run gams (see the beginning part of this file).
Similarly, you can specify the directory where the lst file is stored by setting
gams-lst-dir.
For example,
* gams-lst-dir: ./lst
This code implies the lst directory is "./lst/" and the lst file name is stored
as "./lst/gams-sample.lst".
$offtext
* ---------------------------------------------------------
*@ GAMS statement completions.
* ---------------------------------------------------------
$ontext
You can insert GAMS statements with completion. Type `C-cC-k', then the
following message will appear in the echo are.
Insert statement (default = set):
Type SPACE or TAB key and the list of candidates will appear. If you type
ENTER, the default value `set' is inserted. Or if you type, for example, `v'
and then `SPACE', and the statement `VARIABLE' will be automatically inserted in
the echo are.
Similarly, dollar control options can be inserted with completion. In this
case, type `C-cC-d'.
Moreover, if you type `C-uC-cC-k' or `C-uC-cC-d' on the existing statement or
dollar control, you can replace it with the new one.
$offtext
parameter replace; # Type C-uC-cC-k on `parameter'
set s Index / 1*10 /;
parameter
p(s) Unit cost # End-of-line comment.
out_up(s) Upper limit on out(s)
t_dem Total demand
;
out_up(s) = uniform(1,7);
p(s) = uniform(1,2);
t_dem = sum(s, out_up(s)*0.8);
display out_up, p, t_dem;
variable
OUT(s) Output of factory s
TCOST Total cost
;
equation
eq_tcost
eq_dem Demand constraint
eq_out(s) "Constraint on out(s)"; /* Inline comment. */
eq_tcost .. TCOST =e= sum(s, p(s)*OUT(s));
eq_dem .. sum(s, OUT(s)) =g= t_dem;
eq_out(s) .. OUT(s) =l= out_up(s);
out.lo(s) = 0;
$ontext
Moreover, the command `gams-insert-statement-extended' (C-cC-n) is also
available. This command helps you in inserting various arguments for gams
statement such as model, solve, file, option, if, while, loop, and put.
For example, try
C-cC-n -> model [ENTER]
and then
C-cC-n -> solve [ENTER]
$offtext
* model cost_min Cost minimization / eq_tcost, eq_dem, eq_out /;
* solve cost_min using lp minimizing TCOST;
* ---------------------------------------------------------
*@ Automatic registration of a new statement.
* ---------------------------------------------------------
$ontext
If you are to insert a statement not registered by default, you can register it
for the future use. For example, if you type `abort' like
Insert statement (default = set): abort
and type `ENTER', then you are asked
Store `abort' for future use? Type `y' if yes:
If you type `y' here, the statement `abort' is registered and it is included in
the list of candidates of statement completion. These registered statements are
saved in the file "~/.emacs.d/gams-statement.txt". If you have registered
unnecessary statements, open the file "~/.emacs.d/gams-statement.txt" and delete
them manually.
GAMS has a lot of statements. But only basic statements are registered in
gams-mode.el by default. So, please register statements that you frequently use
by yourself.
$offtext
* ---------------------------------------------------------
*@ auto-complete mode for GAM mode.
* ---------------------------------------------------------
$ontext
auto-complete.el (auto-complete minor mode) enables you to complete words with
popup menu. You can use auto-complete mode in GAMS mode.
To use auto-complete, you first need to install "auto-complete.el" which can be
installed from MELPA.
To use auto-complete in GAMS mode, add the following code to init.el.
;; Load gams-auto-complete.
(require 'gams-ac)
;; Initial setup for auto-complete in GAMS mode.
(gams-ac-after-init-setup)
If you want to add words for auto-complete mode by yourself, add words to the
variable `gams-ac-source-user-keywords-list` like
;; Add the following words to candidates of auto-complete.
(setq gams-ac-source-user-keywords-list
'("computable" "general" "equilibrium"))
$offtext
* ---------------------------------------------------------
*@ Quotation and parenthesis.
* ---------------------------------------------------------
$ontext
Type ', ", or (, and the corresponding ', ", and ) will be automatically
inserted if lisp variables `gams-close-paren-always',
`gams-close-double-quotation-always' and `gams-close-single-quotation-always'
are assigned non-nill. If you attach the universal argument to `(', then only
`(' is inserted.
$offtext
* ---------------------------------------------------------
*@ Insert user defined comment template.
* ---------------------------------------------------------
$ontext
To write a gms file that other people (or yourself) can understand easily, it is
good to use comments effectively. You can insert a comment template by typing
`C-cC-o' (gams-insert-comment). Inserted template is defined by a variable
`gams-user-comment'. You can change the value of this variable. For example, I
put the following in my "init.el".
(setq gams-user-comment
"* ------------------------------------------------------------------------
* %
")
Please see the help of `gams-user-comment'.
$offtext
* ---------------------------------------------------------
*@ GAMS-TEMPLATE.
* ---------------------------------------------------------
$ontext
GAMS-TEMPLATE mode (binded to `C-cC-e' by default) enables you to handle
templates easily. You can easily insert, re-edit, delete, rename, re-order, and
add templates.
There is a sample template file "gams-template.txt" which is distributed with
this file. Save it in your "~/.emacs.d/" directory. To start GAMS-TEMPLATE
mode, type `C-cC-e' in the GAMS mode buffer. If you want to know the commands
in GAMS-TEMPLATE mode, type `h' in the *Template List* buffer.
$offtext
* ---------------------------------------------------------
*@ Fill paragraph.
* ---------------------------------------------------------
$ontext
As in other major modes, filling paragraph works in GAMS mode. Put the cursor
in the next commented out paragraph and type `M-q'.
* Put the cursor around here! This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph....
Put the cursor around here! This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph. This is a sample paragraph....
* This makes two paragraph respectively like
* Put the cursor around here! This is a sample paragraph. This is a
* sample paragraph. This is a sample paragraph. This is a sample
* paragraph. This is a sample paragraph. This is a sample paragraph.
* This is a sample paragraph....
Put the cursor around here! This is a sample paragraph. This is a sample
paragraph. This is a sample paragraph. This is a sample paragraph. This
is a sample paragraph. This is a sample paragraph. This is a sample
paragraph....
$offtext
* ---------------------------------------------------------
*@ Commenting out
* ---------------------------------------------------------
$ontext
You can comment out the region with *. Select a region and type C-cC-;, then
you can comment out that region. If you want to uncomment the commented-out
region, attach the universal argument (i.e. C-uC-cC-;). Try these commands by
yourself.
$offtext
* gams-include-file: ./include/include-sample.gms
$include %sub_program%
* ---------------------------------------------------------
*@ Font-lock (coloring).
* ---------------------------------------------------------
$ontext
GAMS mode for Emacs supports various coloring (font-lock in Emacs terminology).
If you set font-lock-mode on, coloring automatically works in GAMS mode,
GAMS-LST mode, and GAMS-OUTLINE mode. To set font-lock-mode on in these three
modes, put the following your "~/.emacs.d/init.el" file:
(global-font-lock-mode t)
You can choose three coloring levels by `gams-choose-font-lock-level' (binded to
C-cC-f).
0 => no coloring.
1 => minimum coloring.
2 => maximum coloring.
Try it!
$offtext
* Type `C-cC-f' and change the coloring level!
set k Index k / 1, 2 /
l Index l / l1*l10 /;
parameter v Parameter v / 1 /
t Parameter t / 2 /
u(k) Parameter u;
u(k) = 1;
display "Parameter p and q", u;
display 'Single quote p and q', u;
$ontext
This command is available in GAMS mode, GAMS-LST mode, and GAMS-OUTLINE mode.
If you open a large file, it will take much time to color a buffer. So, you may
be better choose low coloring level before opening a large file.
The default level of coloring in each mode is determinied by the variable
`gams-font-lock-level', `gams-lst-font-lock-level', and
`gams-ol-font-lock-level'. All default values are 2 (maximum level).
Moreover, you can re-color a part aroung the cursor (not an entire buffer) by
using `font-lock-fontify-block' (binded to M-gM-g). It is much faster.
If you encounter odd behavior of coloring, please let me know it! I will fix
them.
$offtext
* ---------------------------------------------------------
*@ Display the declaration place of an identifier.
* ---------------------------------------------------------
$ontext
While you are reading or editing a GAMS program, you may often go back to the
declaration place of an identifier so as to see its definition. In such a case,
you could use, for example, `isearch-backward' command or something. But if the
identifier is used many times at the different places of the program or
declared/used in the subroutine files, it is difficult to find the declaration
place of the identifier.
`gams-show-identifier' (binded to F7 or `C-cC-.' by default) enables you to see
the declaration place of the identifier under the cursor. Try to type F7 on the
following examples.
$offtext
u(k) = 1; # Type F7 on the identifier u and k
out.fx(s) = 10;
display out.l; # Type F7 on the identifier p
$ontext
If you type F7 on, for example, the identifier "u", u's declaration place will
appear in the upper window and the position of the cursor will be displayed in
the left window. You will see the following message in the echo are:
The decl. place of `u': [?]help,[d]ecl,[n]ext,[p]rev,[e]copy,[r]escan,[ ]restore,[ENT]jump,[TAB]jump+keep
If you type n(p), you can move to the next (previous) place where "u" appears.
Type d, you can move to the declaration place. Type c, you can move to the
original point.
If you type SPC, the previous window position will be restored. If you type
ENT, you will jump to the declaration place. If you type other keys, two
buffers will continue to be displyed.
Typing ? will show the help.
`gams-show-identifier' can show the declaration place in the subroutine files.
The identifier "ene", "out", "util", "com", "sec", "m" and "n"" below are
declared in the subroutine file "include-sample.gms" and "include-sample-2.gms".
Type F7 on each identifier.
$offtext
display ene; # Type F7 on the identifier ene
display op; # Type F7 on the identifier oq
display util;
ene(com,sec) = 100;
op(sec) = 1000;
display ene, op, sec, com;
m = -100;
n = -200;
display m, n;
a = 1; # Type F7 on the identifier a
display a; # Type F7 on the identifier a
$ontext
If you attach universal-argument, (i.e. C-uC-cC-.), you are asked the identifier
that you want to search. Try "C-uC-cC-.".
$offtext
* ---------------------------------------------------------
*@ Display the list of identifiers.
* ---------------------------------------------------------
$ontext
`gams-show-identifier-list' (binded to `C-cC-a' by default) displays the list
identifiers (sets, parameters, variables and so on) defined in the current
program file. To learn how to use this command, try C-cC-a and type `?'.
If you use `gams-show-identifier-list' (C-cC-a), it shows all identifiers
including those which are defined in subroutine files. However, if you use the
following expression to include subroutine files, GAMS mode cannot read the
subroutine files because GAMS mode does not know the value of %sub_program%.
$include %sub_program%
In this case, you can make GAMS mode read the subroutine
`./include/include-sample.gms' by adding to the following code before $include
command.
* gams-include-file: ./include/include-sample.gms
$include %sub_program%
The line starting with "* gams-include-file:" specifies the subroutine file for
`gams-show-identifier-list'.
The value of %sub_program% changes through $set or $setglobal command, but you
can specifiy the default subroutine file name by `gams-include-file'.
$offtext
* ---------------------------------------------------------
*@ Commands on a ontext-offtext pair.
* ---------------------------------------------------------
$ontext
`gams-insert-on-off-text' (binded to `C-cC-c' by default) inserts an
ontext-offtext pair. If you attach the universal-argument (i.e. `C-uC-cC-c'),
this command encloses the specified region with an ontext-offtext pair.
Using `gams-jump-on-off-text' (`C-cC-g') on an ontext (offtext), you can jump to
the corresponding offtext (ontext).
Using `gams-comment-on-off-text' (`C-cM-c') on an ontext (offtext), you can
comment out or uncomment a pair of ontext-offtext.
Using `gams-remove-on-off-text' (`C-cM-g') on an ontext (offtext), you can
remove a pair of ontext-offtext.
$offtext
display "Try to type C-cC-c, C-uC-cC-c, C-cC-g, C-cM-c, and C-cM-g",
"on a ontext or offtext!";
* ---------------------------------------------------------
*@ Align block.
* ---------------------------------------------------------
$ontext
You can align table and other blocks according to GAMS systax by
`gams-align-block' (C-cC-y).
[Example 1]
Set the region from the header line to the end of the table and type C-cC-y -> t
-> 3 -> y. Then, the table below is formatted.
* Before
table table1 test table
Japan USA EU China Korea
agriculture 70 4 24 197 3
fishery 21 8 0 17 27
textile 4 6 106 2 -8
food 9 415 0 95 15
energy 0 8 6 -327 7
;
* After
table table1 test table
Japan USA EU China Korea
agriculture 70 4 24 197 3
fishery 21 8 0 17 27
textile 4 6 106 2 -8
food 9 415 0 95 15
energy 0 8 6 -327 7
[Example 2]
Set the regions from `Start' to `End' and then type C-cC-y -> o. Then all =
symbols are aligned like
parameter
abc(*);
* Before
* Start.
abc("agriculture") = 100;
abc("fishery") = 200;
abc("textile") = 1;
abc("food") = 20;
abc("energy") = 123;
* End.
* After
* Start.
abc("agriculture") = 100;
abc("fishery") = 200;
abc("textile") = 1;
abc("food") = 20;
abc("energy") = 123;
* End.
display abc;
$offtext
* ---------------------------------------------------------
*@ Automatic indentation.
* ---------------------------------------------------------
$ontext
You can indent GAMS programs accordint to GAMS syntax.
M-C-\ = Indent region. Specify region and type M-C-\.
TAB = Indent the current line.
Select the following region and the type `M-C-\' (`indent-region').
$offtext
* ----------------------------------------------------------------------
* From here.
* ----------------------------------------------------------------------
set i Index / i1*i2 /
j Index / j1*j2 /;
parameter
para(i,j) Parameter a
parb(i,j) Parameter b
parc(i,j,*) Parameter c;
para(i,j) = uniform(0,1);
loop((i,j),
* Display i.
display "Display set i", i;
* Display j.
display "Display set j", j;
if((para(i,j) > 0.5),
display "para is greater than 0.5!";
else
display "para is less than 0.5!";
);
parb(i,j) = para(i,j) * 2;
parc(i,j,"a") = para(i,j);
parc(i,j,"b") = parb(i,j);
* Display parc.
display parc;
);
* ----------------------------------------------------------------------
* Until here
* ----------------------------------------------------------------------
$ontext
Select the above region and type `M-C-\' (`indent-region'), then the above
region is indented like the following:
set i Index / i1*i2 /
j Index / j1*j2 /;
parameter
para(i,j) Parameter a
parb(i,j) Parameter b
parc(i,j,*) Parameter c;
para(i,j) = uniform(0,1);
loop((i,j),
* Display i.
display "Set i", i;
* Display j.
display "Set j", j;
if((para(i,j) > 0.5),
display "para is greater than 0.5!";
else
display "para is less than 0.5!";
);
parb(i,j) = para(i,j) * 2;
parc(i,j,"a") = para(i,j);
parc(i,j,"b") = parb(i,j);
* Display parc.
display parc;
);
=== Note ===
To make automatic indentation in GAMS mode work well, please end reserved word
blocks (e.g. parameter, table, set, display blocks etc.) with a semicolon (;)
although it may not be necessarily required in GAMS syntax.
$offtext
* ---------------------------------------------------------
*@ View manual.
* ---------------------------------------------------------
$ontext
In GAMS Studio (or GAMSIDE), you can view GAMS manuals from Help. The same kind
of command is available in GAMS mode. The command name is `gams-view-document'
and it is binded to `C-cC-m' by default.
Try type `C-cC-m' in the GAMS mode buffer. Then you see the following message in
echo area.
Press ENTER key if you use online manual. Press other keys for offline manual.
If you press ENTER key, then the default brower opens GAMS online manual (GAMS