aboutsummaryrefslogtreecommitdiff
path: root/src/nvim/arabic.c
blob: 9fba38a49f5771dc0e90994d79be3c4e3f1018f6 (plain) (blame)
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
// This is an open source non-commercial project. Dear PVS-Studio, please check
// it. PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com

/// @file arabic.c
///
/// Functions for Arabic language.
///
/// Arabic characters are categorized into following types:
///
/// Isolated    - iso-8859-6 form         char denoted with  a_*
/// Initial     - unicode form-B start    char denoted with  a_i_*
/// Medial      - unicode form-B middle   char denoted with  a_m_*
/// Final       - unicode form-B final    char denoted with  a_f_*
/// Stand-Alone - unicode form-B isolated char denoted with  a_s_* (NOT USED)

#include <stdbool.h>

#include "nvim/vim.h"
#include "nvim/ascii.h"
#include "nvim/arabic.h"

// Arabic ISO-10646-1 character set definition

// Arabic ISO-8859-6 (subset of 10646; 0600 - 06FF)
#define a_COMMA                         0x060C
#define a_SEMICOLON                     0x061B
#define a_QUESTION                      0x061F
#define a_HAMZA                         0x0621
#define a_ALEF_MADDA                    0x0622
#define a_ALEF_HAMZA_ABOVE              0x0623
#define a_WAW_HAMZA                     0x0624
#define a_ALEF_HAMZA_BELOW              0x0625
#define a_YEH_HAMZA                     0x0626
#define a_ALEF                          0x0627
#define a_BEH                           0x0628
#define a_TEH_MARBUTA                   0x0629
#define a_TEH                           0x062a
#define a_THEH                          0x062b
#define a_JEEM                          0x062c
#define a_HAH                           0x062d
#define a_KHAH                          0x062e
#define a_DAL                           0x062f
#define a_THAL                          0x0630
#define a_REH                           0x0631
#define a_ZAIN                          0x0632
#define a_SEEN                          0x0633
#define a_SHEEN                         0x0634
#define a_SAD                           0x0635
#define a_DAD                           0x0636
#define a_TAH                           0x0637
#define a_ZAH                           0x0638
#define a_AIN                           0x0639
#define a_GHAIN                         0x063a
#define a_TATWEEL                       0x0640
#define a_FEH                           0x0641
#define a_QAF                           0x0642
#define a_KAF                           0x0643
#define a_LAM                           0x0644
#define a_MEEM                          0x0645
#define a_NOON                          0x0646
#define a_HEH                           0x0647
#define a_WAW                           0x0648
#define a_ALEF_MAKSURA                  0x0649
#define a_YEH                           0x064a

#define a_FATHATAN                      0x064b
#define a_DAMMATAN                      0x064c
#define a_KASRATAN                      0x064d
#define a_FATHA                         0x064e
#define a_DAMMA                         0x064f
#define a_KASRA                         0x0650
#define a_SHADDA                        0x0651
#define a_SUKUN                         0x0652

#define a_MADDA_ABOVE                   0x0653
#define a_HAMZA_ABOVE                   0x0654
#define a_HAMZA_BELOW                   0x0655

#define a_ZERO                          0x0660
#define a_ONE                           0x0661
#define a_TWO                           0x0662
#define a_THREE                         0x0663
#define a_FOUR                          0x0664
#define a_FIVE                          0x0665
#define a_SIX                           0x0666
#define a_SEVEN                         0x0667
#define a_EIGHT                         0x0668
#define a_NINE                          0x0669
#define a_PERCENT                       0x066a
#define a_DECIMAL                       0x066b
#define a_THOUSANDS                     0x066c
#define a_STAR                          0x066d
#define a_MINI_ALEF                     0x0670
// Rest of 8859-6 does not relate to Arabic

// Arabic Presentation Form-B (subset of 10646; FE70 - FEFF)
//
//  s -> isolated
//  i -> initial
//  m -> medial
//  f -> final
#define a_s_FATHATAN                    0xfe70
#define a_m_TATWEEL_FATHATAN            0xfe71
#define a_s_DAMMATAN                    0xfe72

#define a_s_KASRATAN                    0xfe74

#define a_s_FATHA                       0xfe76
#define a_m_FATHA                       0xfe77
#define a_s_DAMMA                       0xfe78
#define a_m_DAMMA                       0xfe79
#define a_s_KASRA                       0xfe7a
#define a_m_KASRA                       0xfe7b
#define a_s_SHADDA                      0xfe7c
#define a_m_SHADDA                      0xfe7d
#define a_s_SUKUN                       0xfe7e
#define a_m_SUKUN                       0xfe7f

#define a_s_HAMZA                       0xfe80
#define a_s_ALEF_MADDA                  0xfe81
#define a_f_ALEF_MADDA                  0xfe82
#define a_s_ALEF_HAMZA_ABOVE            0xfe83
#define a_f_ALEF_HAMZA_ABOVE            0xfe84
#define a_s_WAW_HAMZA                   0xfe85
#define a_f_WAW_HAMZA                   0xfe86
#define a_s_ALEF_HAMZA_BELOW            0xfe87
#define a_f_ALEF_HAMZA_BELOW            0xfe88
#define a_s_YEH_HAMZA                   0xfe89
#define a_f_YEH_HAMZA                   0xfe8a
#define a_i_YEH_HAMZA                   0xfe8b
#define a_m_YEH_HAMZA                   0xfe8c
#define a_s_ALEF                        0xfe8d
#define a_f_ALEF                        0xfe8e
#define a_s_BEH                         0xfe8f
#define a_f_BEH                         0xfe90
#define a_i_BEH                         0xfe91
#define a_m_BEH                         0xfe92
#define a_s_TEH_MARBUTA                 0xfe93
#define a_f_TEH_MARBUTA                 0xfe94
#define a_s_TEH                         0xfe95
#define a_f_TEH                         0xfe96
#define a_i_TEH                         0xfe97
#define a_m_TEH                         0xfe98
#define a_s_THEH                        0xfe99
#define a_f_THEH                        0xfe9a
#define a_i_THEH                        0xfe9b
#define a_m_THEH                        0xfe9c
#define a_s_JEEM                        0xfe9d
#define a_f_JEEM                        0xfe9e
#define a_i_JEEM                        0xfe9f
#define a_m_JEEM                        0xfea0
#define a_s_HAH                         0xfea1
#define a_f_HAH                         0xfea2
#define a_i_HAH                         0xfea3
#define a_m_HAH                         0xfea4
#define a_s_KHAH                        0xfea5
#define a_f_KHAH                        0xfea6
#define a_i_KHAH                        0xfea7
#define a_m_KHAH                        0xfea8
#define a_s_DAL                         0xfea9
#define a_f_DAL                         0xfeaa
#define a_s_THAL                        0xfeab
#define a_f_THAL                        0xfeac
#define a_s_REH                         0xfead
#define a_f_REH                         0xfeae
#define a_s_ZAIN                        0xfeaf
#define a_f_ZAIN                        0xfeb0
#define a_s_SEEN                        0xfeb1
#define a_f_SEEN                        0xfeb2
#define a_i_SEEN                        0xfeb3
#define a_m_SEEN                        0xfeb4
#define a_s_SHEEN                       0xfeb5
#define a_f_SHEEN                       0xfeb6
#define a_i_SHEEN                       0xfeb7
#define a_m_SHEEN                       0xfeb8
#define a_s_SAD                         0xfeb9
#define a_f_SAD                         0xfeba
#define a_i_SAD                         0xfebb
#define a_m_SAD                         0xfebc
#define a_s_DAD                         0xfebd
#define a_f_DAD                         0xfebe
#define a_i_DAD                         0xfebf
#define a_m_DAD                         0xfec0
#define a_s_TAH                         0xfec1
#define a_f_TAH                         0xfec2
#define a_i_TAH                         0xfec3
#define a_m_TAH                         0xfec4
#define a_s_ZAH                         0xfec5
#define a_f_ZAH                         0xfec6
#define a_i_ZAH                         0xfec7
#define a_m_ZAH                         0xfec8
#define a_s_AIN                         0xfec9
#define a_f_AIN                         0xfeca
#define a_i_AIN                         0xfecb
#define a_m_AIN                         0xfecc
#define a_s_GHAIN                       0xfecd
#define a_f_GHAIN                       0xfece
#define a_i_GHAIN                       0xfecf
#define a_m_GHAIN                       0xfed0
#define a_s_FEH                         0xfed1
#define a_f_FEH                         0xfed2
#define a_i_FEH                         0xfed3
#define a_m_FEH                         0xfed4
#define a_s_QAF                         0xfed5
#define a_f_QAF                         0xfed6
#define a_i_QAF                         0xfed7
#define a_m_QAF                         0xfed8
#define a_s_KAF                         0xfed9
#define a_f_KAF                         0xfeda
#define a_i_KAF                         0xfedb
#define a_m_KAF                         0xfedc
#define a_s_LAM                         0xfedd
#define a_f_LAM                         0xfede
#define a_i_LAM                         0xfedf
#define a_m_LAM                         0xfee0
#define a_s_MEEM                        0xfee1
#define a_f_MEEM                        0xfee2
#define a_i_MEEM                        0xfee3
#define a_m_MEEM                        0xfee4
#define a_s_NOON                        0xfee5
#define a_f_NOON                        0xfee6
#define a_i_NOON                        0xfee7
#define a_m_NOON                        0xfee8
#define a_s_HEH                         0xfee9
#define a_f_HEH                         0xfeea
#define a_i_HEH                         0xfeeb
#define a_m_HEH                         0xfeec
#define a_s_WAW                         0xfeed
#define a_f_WAW                         0xfeee
#define a_s_ALEF_MAKSURA                0xfeef
#define a_f_ALEF_MAKSURA                0xfef0
#define a_s_YEH                         0xfef1
#define a_f_YEH                         0xfef2
#define a_i_YEH                         0xfef3
#define a_m_YEH                         0xfef4
#define a_s_LAM_ALEF_MADDA_ABOVE        0xfef5
#define a_f_LAM_ALEF_MADDA_ABOVE        0xfef6
#define a_s_LAM_ALEF_HAMZA_ABOVE        0xfef7
#define a_f_LAM_ALEF_HAMZA_ABOVE        0xfef8
#define a_s_LAM_ALEF_HAMZA_BELOW        0xfef9
#define a_f_LAM_ALEF_HAMZA_BELOW        0xfefa
#define a_s_LAM_ALEF                    0xfefb
#define a_f_LAM_ALEF                    0xfefc

#define a_BYTE_ORDER_MARK               0xfeff


#ifdef INCLUDE_GENERATED_DECLARATIONS
# include "arabic.c.generated.h"
#endif

// Returns true if c is an ISO-8859-6 shaped ARABIC letter (user entered).
static bool A_is_a(int cur_c)
{
  switch (cur_c) {
    case a_HAMZA:
    case a_ALEF_MADDA:
    case a_ALEF_HAMZA_ABOVE:
    case a_WAW_HAMZA:
    case a_ALEF_HAMZA_BELOW:
    case a_YEH_HAMZA:
    case a_ALEF:
    case a_BEH:
    case a_TEH_MARBUTA:
    case a_TEH:
    case a_THEH:
    case a_JEEM:
    case a_HAH:
    case a_KHAH:
    case a_DAL:
    case a_THAL:
    case a_REH:
    case a_ZAIN:
    case a_SEEN:
    case a_SHEEN:
    case a_SAD:
    case a_DAD:
    case a_TAH:
    case a_ZAH:
    case a_AIN:
    case a_GHAIN:
    case a_TATWEEL:
    case a_FEH:
    case a_QAF:
    case a_KAF:
    case a_LAM:
    case a_MEEM:
    case a_NOON:
    case a_HEH:
    case a_WAW:
    case a_ALEF_MAKSURA:
    case a_YEH:
      return true;
  }

  return false;
}

// Returns true if c is an Isolated Form-B ARABIC letter
static bool A_is_s(int cur_c)
{
  switch (cur_c) {
    case a_s_HAMZA:
    case a_s_ALEF_MADDA:
    case a_s_ALEF_HAMZA_ABOVE:
    case a_s_WAW_HAMZA:
    case a_s_ALEF_HAMZA_BELOW:
    case a_s_YEH_HAMZA:
    case a_s_ALEF:
    case a_s_BEH:
    case a_s_TEH_MARBUTA:
    case a_s_TEH:
    case a_s_THEH:
    case a_s_JEEM:
    case a_s_HAH:
    case a_s_KHAH:
    case a_s_DAL:
    case a_s_THAL:
    case a_s_REH:
    case a_s_ZAIN:
    case a_s_SEEN:
    case a_s_SHEEN:
    case a_s_SAD:
    case a_s_DAD:
    case a_s_TAH:
    case a_s_ZAH:
    case a_s_AIN:
    case a_s_GHAIN:
    case a_s_FEH:
    case a_s_QAF:
    case a_s_KAF:
    case a_s_LAM:
    case a_s_MEEM:
    case a_s_NOON:
    case a_s_HEH:
    case a_s_WAW:
    case a_s_ALEF_MAKSURA:
    case a_s_YEH:
      return true;
  }

  return false;
}

// Returns true if c is a Final shape of an ARABIC letter
static bool A_is_f(int cur_c)
{
  switch (cur_c) {
    case a_f_ALEF_MADDA:
    case a_f_ALEF_HAMZA_ABOVE:
    case a_f_WAW_HAMZA:
    case a_f_ALEF_HAMZA_BELOW:
    case a_f_YEH_HAMZA:
    case a_f_ALEF:
    case a_f_BEH:
    case a_f_TEH_MARBUTA:
    case a_f_TEH:
    case a_f_THEH:
    case a_f_JEEM:
    case a_f_HAH:
    case a_f_KHAH:
    case a_f_DAL:
    case a_f_THAL:
    case a_f_REH:
    case a_f_ZAIN:
    case a_f_SEEN:
    case a_f_SHEEN:
    case a_f_SAD:
    case a_f_DAD:
    case a_f_TAH:
    case a_f_ZAH:
    case a_f_AIN:
    case a_f_GHAIN:
    case a_f_FEH:
    case a_f_QAF:
    case a_f_KAF:
    case a_f_LAM:
    case a_f_MEEM:
    case a_f_NOON:
    case a_f_HEH:
    case a_f_WAW:
    case a_f_ALEF_MAKSURA:
    case a_f_YEH:
    case a_f_LAM_ALEF_MADDA_ABOVE:
    case a_f_LAM_ALEF_HAMZA_ABOVE:
    case a_f_LAM_ALEF_HAMZA_BELOW:
    case a_f_LAM_ALEF:
      return true;
  }
  return false;
}

// Change shape - from ISO-8859-6/Isolated to Form-B Isolated
static int chg_c_a2s(int cur_c)
{
  switch (cur_c) {
    case a_HAMZA: return a_s_HAMZA;
    case a_ALEF_MADDA: return a_s_ALEF_MADDA;
    case a_ALEF_HAMZA_ABOVE: return a_s_ALEF_HAMZA_ABOVE;
    case a_WAW_HAMZA: return a_s_WAW_HAMZA;
    case a_ALEF_HAMZA_BELOW: return a_s_ALEF_HAMZA_BELOW;
    case a_YEH_HAMZA: return a_s_YEH_HAMZA;
    case a_ALEF: return a_s_ALEF;
    case a_TEH_MARBUTA: return a_s_TEH_MARBUTA;
    case a_DAL: return a_s_DAL;
    case a_THAL: return a_s_THAL;
    case a_REH: return a_s_REH;
    case a_ZAIN: return a_s_ZAIN;
    case a_TATWEEL: return cur_c;   // exceptions
    case a_WAW: return a_s_WAW;
    case a_ALEF_MAKSURA: return a_s_ALEF_MAKSURA;
    case a_BEH: return a_s_BEH;
    case a_TEH: return a_s_TEH;
    case a_THEH: return a_s_THEH;
    case a_JEEM: return a_s_JEEM;
    case a_HAH: return a_s_HAH;
    case a_KHAH: return a_s_KHAH;
    case a_SEEN: return a_s_SEEN;
    case a_SHEEN: return a_s_SHEEN;
    case a_SAD: return a_s_SAD;
    case a_DAD: return a_s_DAD;
    case a_TAH: return a_s_TAH;
    case a_ZAH: return a_s_ZAH;
    case a_AIN: return a_s_AIN;
    case a_GHAIN: return a_s_GHAIN;
    case a_FEH: return a_s_FEH;
    case a_QAF: return a_s_QAF;
    case a_KAF: return a_s_KAF;
    case a_LAM: return a_s_LAM;
    case a_MEEM: return a_s_MEEM;
    case a_NOON: return a_s_NOON;
    case a_HEH: return a_s_HEH;
    case a_YEH: return a_s_YEH;
  }
  return 0;
}

// Change shape - from ISO-8859-6/Isolated to Initial
static int chg_c_a2i(int cur_c)
{
  switch (cur_c) {
    case a_YEH_HAMZA: return a_i_YEH_HAMZA;
    case a_HAMZA: return a_s_HAMZA;  // exceptions
    case a_ALEF_MADDA: return a_s_ALEF_MADDA;  // exceptions
    case a_ALEF_HAMZA_ABOVE: return a_s_ALEF_HAMZA_ABOVE;  // exceptions
    case a_WAW_HAMZA: return a_s_WAW_HAMZA;  // exceptions
    case a_ALEF_HAMZA_BELOW: return a_s_ALEF_HAMZA_BELOW;  // exceptions
    case a_ALEF: return a_s_ALEF;  // exceptions
    case a_TEH_MARBUTA: return a_s_TEH_MARBUTA;  // exceptions
    case a_DAL: return a_s_DAL;  // exceptions
    case a_THAL: return a_s_THAL;  // exceptions
    case a_REH: return a_s_REH;  // exceptions
    case a_ZAIN: return a_s_ZAIN;  // exceptions
    case a_TATWEEL: return cur_c;  // exceptions
    case a_WAW: return a_s_WAW;  // exceptions
    case a_ALEF_MAKSURA: return a_s_ALEF_MAKSURA;  // exceptions
    case a_BEH: return a_i_BEH;
    case a_TEH: return a_i_TEH;
    case a_THEH: return a_i_THEH;
    case a_JEEM: return a_i_JEEM;
    case a_HAH: return a_i_HAH;
    case a_KHAH: return a_i_KHAH;
    case a_SEEN: return a_i_SEEN;
    case a_SHEEN: return a_i_SHEEN;
    case a_SAD: return a_i_SAD;
    case a_DAD: return a_i_DAD;
    case a_TAH: return a_i_TAH;
    case a_ZAH: return a_i_ZAH;
    case a_AIN: return a_i_AIN;
    case a_GHAIN: return a_i_GHAIN;
    case a_FEH: return a_i_FEH;
    case a_QAF: return a_i_QAF;
    case a_KAF: return a_i_KAF;
    case a_LAM: return a_i_LAM;
    case a_MEEM: return a_i_MEEM;
    case a_NOON: return a_i_NOON;
    case a_HEH: return a_i_HEH;
    case a_YEH: return a_i_YEH;
  }
  return 0;
}

// Change shape - from ISO-8859-6/Isolated to Medial
static int chg_c_a2m(int cur_c)
{
  switch (cur_c) {
    case a_HAMZA: return a_s_HAMZA;  // exception
    case a_ALEF_MADDA: return a_f_ALEF_MADDA;    // exception
    case a_ALEF_HAMZA_ABOVE: return a_f_ALEF_HAMZA_ABOVE;    // exception
    case a_WAW_HAMZA: return a_f_WAW_HAMZA;  // exception
    case a_ALEF_HAMZA_BELOW: return a_f_ALEF_HAMZA_BELOW;    // exception
    case a_YEH_HAMZA: return a_m_YEH_HAMZA;
    case a_ALEF: return a_f_ALEF;    // exception
    case a_BEH: return a_m_BEH;
    case a_TEH_MARBUTA: return a_f_TEH_MARBUTA;  // exception
    case a_TEH: return a_m_TEH;
    case a_THEH: return a_m_THEH;
    case a_JEEM: return a_m_JEEM;
    case a_HAH: return a_m_HAH;
    case a_KHAH: return a_m_KHAH;
    case a_DAL: return a_f_DAL;  // exception
    case a_THAL: return a_f_THAL;    // exception
    case a_REH: return a_f_REH;  // exception
    case a_ZAIN: return a_f_ZAIN;    // exception
    case a_SEEN: return a_m_SEEN;
    case a_SHEEN: return a_m_SHEEN;
    case a_SAD: return a_m_SAD;
    case a_DAD: return a_m_DAD;
    case a_TAH: return a_m_TAH;
    case a_ZAH: return a_m_ZAH;
    case a_AIN: return a_m_AIN;
    case a_GHAIN: return a_m_GHAIN;
    case a_TATWEEL: return cur_c;    // exception
    case a_FEH: return a_m_FEH;
    case a_QAF: return a_m_QAF;
    case a_KAF: return a_m_KAF;
    case a_LAM: return a_m_LAM;
    case a_MEEM: return a_m_MEEM;
    case a_NOON: return a_m_NOON;
    case a_HEH: return a_m_HEH;
    case a_WAW: return a_f_WAW;  // exception
    case a_ALEF_MAKSURA: return a_f_ALEF_MAKSURA;    // exception
    case a_YEH: return a_m_YEH;
  }
  return 0;
}

// Change shape - from ISO-8859-6/Isolated to final
static int chg_c_a2f(int cur_c)
{
  // NOTE: these encodings need to be accounted for
  //
  // a_f_ALEF_MADDA;
  // a_f_ALEF_HAMZA_ABOVE;
  // a_f_ALEF_HAMZA_BELOW;
  // a_f_LAM_ALEF_MADDA_ABOVE;
  // a_f_LAM_ALEF_HAMZA_ABOVE;
  // a_f_LAM_ALEF_HAMZA_BELOW;

  switch (cur_c) {
    case a_HAMZA: return a_s_HAMZA;  // exception
    case a_ALEF_MADDA: return a_f_ALEF_MADDA;
    case a_ALEF_HAMZA_ABOVE: return a_f_ALEF_HAMZA_ABOVE;
    case a_WAW_HAMZA: return a_f_WAW_HAMZA;
    case a_ALEF_HAMZA_BELOW: return a_f_ALEF_HAMZA_BELOW;
    case a_YEH_HAMZA: return a_f_YEH_HAMZA;
    case a_ALEF: return a_f_ALEF;
    case a_BEH: return a_f_BEH;
    case a_TEH_MARBUTA: return a_f_TEH_MARBUTA;
    case a_TEH: return a_f_TEH;
    case a_THEH: return a_f_THEH;
    case a_JEEM: return a_f_JEEM;
    case a_HAH: return a_f_HAH;
    case a_KHAH: return a_f_KHAH;
    case a_DAL: return a_f_DAL;
    case a_THAL: return a_f_THAL;
    case a_REH: return a_f_REH;
    case a_ZAIN: return a_f_ZAIN;
    case a_SEEN: return a_f_SEEN;
    case a_SHEEN: return a_f_SHEEN;
    case a_SAD: return a_f_SAD;
    case a_DAD: return a_f_DAD;
    case a_TAH: return a_f_TAH;
    case a_ZAH: return a_f_ZAH;
    case a_AIN: return a_f_AIN;
    case a_GHAIN: return a_f_GHAIN;
    case a_TATWEEL: return cur_c;   // exception
    case a_FEH: return a_f_FEH;
    case a_QAF: return a_f_QAF;
    case a_KAF: return a_f_KAF;
    case a_LAM: return a_f_LAM;
    case a_MEEM: return a_f_MEEM;
    case a_NOON: return a_f_NOON;
    case a_HEH: return a_f_HEH;
    case a_WAW: return a_f_WAW;
    case a_ALEF_MAKSURA: return a_f_ALEF_MAKSURA;
    case a_YEH: return a_f_YEH;
  }
  return 0;
}

// Change shape - from Initial to Medial
// This code is unreachable, because for the relevant characters ARABIC_CHAR()
// is FALSE;
#if 0
static int chg_c_i2m(int cur_c)
{
  switch (cur_c) {
    case a_i_YEH_HAMZA: return a_m_YEH_HAMZA;
    case a_i_BEH: return a_m_BEH;
    case a_i_TEH: return a_m_TEH;
    case a_i_THEH: return a_m_THEH;
    case a_i_JEEM: return a_m_JEEM;
    case a_i_HAH: return a_m_HAH;
    case a_i_KHAH: return a_m_KHAH;
    case a_i_SEEN: return a_m_SEEN;
    case a_i_SHEEN: return a_m_SHEEN;
    case a_i_SAD: return a_m_SAD;
    case a_i_DAD: return a_m_DAD;
    case a_i_TAH: return a_m_TAH;
    case a_i_ZAH: return a_m_ZAH;
    case a_i_AIN: return a_m_AIN;
    case a_i_GHAIN: return a_m_GHAIN;
    case a_i_FEH: return a_m_FEH;
    case a_i_QAF: return a_m_QAF;
    case a_i_KAF: return a_m_KAF;
    case a_i_LAM: return a_m_LAM;
    case a_i_MEEM: return a_m_MEEM;
    case a_i_NOON: return a_m_NOON;
    case a_i_HEH: return a_m_HEH;
    case a_i_YEH: return a_m_YEH;
  }
  return 0;
}
#endif

// Change shape - from Final to Medial
static int chg_c_f2m(int cur_c)
{
  switch (cur_c) {
    // NOTE: these encodings are multi-positional, no ?
    // case a_f_ALEF_MADDA:
    // case a_f_ALEF_HAMZA_ABOVE:
    // case a_f_ALEF_HAMZA_BELOW:
    case a_f_YEH_HAMZA: return a_m_YEH_HAMZA;
    case a_f_WAW_HAMZA:  // exceptions
    case a_f_ALEF:
    case a_f_TEH_MARBUTA:
    case a_f_DAL:
    case a_f_THAL:
    case a_f_REH:
    case a_f_ZAIN:
    case a_f_WAW:
    case a_f_ALEF_MAKSURA:
      return cur_c;
    case a_f_BEH: return a_m_BEH;
    case a_f_TEH: return a_m_TEH;
    case a_f_THEH: return a_m_THEH;
    case a_f_JEEM: return a_m_JEEM;
    case a_f_HAH: return a_m_HAH;
    case a_f_KHAH: return a_m_KHAH;
    case a_f_SEEN: return a_m_SEEN;
    case a_f_SHEEN: return a_m_SHEEN;
    case a_f_SAD: return a_m_SAD;
    case a_f_DAD: return a_m_DAD;
    case a_f_TAH: return a_m_TAH;
    case a_f_ZAH: return a_m_ZAH;
    case a_f_AIN: return a_m_AIN;
    case a_f_GHAIN: return a_m_GHAIN;
    case a_f_FEH: return a_m_FEH;
    case a_f_QAF: return a_m_QAF;
    case a_f_KAF: return a_m_KAF;
    case a_f_LAM: return a_m_LAM;
    case a_f_MEEM: return a_m_MEEM;
    case a_f_NOON: return a_m_NOON;
    case a_f_HEH: return a_m_HEH;
    case a_f_YEH: return a_m_YEH;
    // NOTE: these encodings are multi-positional, no ?
    //   case a_f_LAM_ALEF_MADDA_ABOVE:
    //   case a_f_LAM_ALEF_HAMZA_ABOVE:
    //   case a_f_LAM_ALEF_HAMZA_BELOW:
    //   case a_f_LAM_ALEF:
  }
  return 0;
}

// Change shape - from Combination (2 char) to an Isolated.
static int chg_c_laa2i(int hid_c)
{
  switch (hid_c) {
    case a_ALEF_MADDA: return a_s_LAM_ALEF_MADDA_ABOVE;
    case a_ALEF_HAMZA_ABOVE: return a_s_LAM_ALEF_HAMZA_ABOVE;
    case a_ALEF_HAMZA_BELOW: return a_s_LAM_ALEF_HAMZA_BELOW;
    case a_ALEF: return a_s_LAM_ALEF;
  }
  return 0;
}

// Change shape - from Combination-Isolated to Final.
static int chg_c_laa2f(int hid_c)
{
  switch (hid_c) {
    case a_ALEF_MADDA: return a_f_LAM_ALEF_MADDA_ABOVE;
    case a_ALEF_HAMZA_ABOVE: return a_f_LAM_ALEF_HAMZA_ABOVE;
    case a_ALEF_HAMZA_BELOW: return a_f_LAM_ALEF_HAMZA_BELOW;
    case a_ALEF: return a_f_LAM_ALEF;
  }
  return 0;
}

// Do "half-shaping" on character "c". Return zero if no shaping.
static int half_shape(int c)
{
  if (A_is_a(c)) {
    return chg_c_a2i(c);
  }

  if (A_is_valid(c) && A_is_f(c)) {
    return chg_c_f2m(c);
  }
  return 0;
}

// Do Arabic shaping on character "c".  Returns the shaped character.
// out:    "ccp" points to the first byte of the character to be shaped.
// in/out: "c1p" points to the first composing char for "c".
// in:     "prev_c"  is the previous character (not shaped)
// in:     "prev_c1" is the first composing char for the previous char
//          (not shaped)
// in:     "next_c"  is the next character (not shaped).
int arabic_shape(int c, int *ccp, int *c1p, int prev_c, int prev_c1,
                 int next_c)
{
  // Deal only with Arabic character, pass back all others
  if (!A_is_ok(c)) {
    return c;
  }

  // half-shape current and previous character
  int shape_c = half_shape(prev_c);

  int curr_c;
  int curr_laa = A_firstc_laa(c, *c1p);
  int prev_laa = A_firstc_laa(prev_c, prev_c1);

  if (curr_laa) {
    if (A_is_valid(prev_c) && !A_is_f(shape_c) && !A_is_s(shape_c)
        && !prev_laa) {
      curr_c = chg_c_laa2f(curr_laa);
    } else {
      curr_c = chg_c_laa2i(curr_laa);
    }

    // Remove the composing character
    *c1p = 0;
  } else if (!A_is_valid(prev_c) && A_is_valid(next_c)) {
    curr_c = chg_c_a2i(c);
  } else if (!shape_c || A_is_f(shape_c) || A_is_s(shape_c) || prev_laa) {
    curr_c = A_is_valid(next_c) ? chg_c_a2i(c) : chg_c_a2s(c);
  } else if (A_is_valid(next_c)) {
#if 0
    curr_c = A_is_iso(c) ? chg_c_a2m(c) : chg_c_i2m(c);
#else
    curr_c = A_is_iso(c) ? chg_c_a2m(c) : 0;
#endif
  } else if (A_is_valid(prev_c)) {
    curr_c = chg_c_a2f(c);
  } else {
    curr_c = chg_c_a2s(c);
  }

  // Sanity check -- curr_c should, in the future, never be 0.
  // We should, in the future, insert a fatal error here.
  if (curr_c == NUL) {
    curr_c = c;
  }

  if ((curr_c != c) && (ccp != NULL)) {
    char_u buf[MB_MAXBYTES + 1];

    // Update the first byte of the character
    utf_char2bytes(curr_c, buf);
    *ccp = buf[0];
  }

  // Return the shaped character
  return curr_c;
}

/// Check whether we are dealing with Arabic combining characters.
/// Note: these are NOT really composing characters!
///
/// @param one First character.
/// @param two Character just after "one".
bool arabic_combine(int one, int two)
{
  if (one == a_LAM) {
    return arabic_maycombine(two);
  }
  return false;
}

/// Check whether we are dealing with a character that could be regarded as an
/// Arabic combining character, need to check the character before this.
bool arabic_maycombine(int two)
{
  if (p_arshape && !p_tbidi) {
    return two == a_ALEF_MADDA
      || two == a_ALEF_HAMZA_ABOVE
      || two == a_ALEF_HAMZA_BELOW
      || two == a_ALEF;
  }
  return false;
}

// A_firstc_laa returns first character of LAA combination if it ex.ists
// in: "c" base character
// in: "c1" first composing character
static int A_firstc_laa(int c, int c1)
{
  if ((c1 != NUL) && (c == a_LAM) && !A_is_harakat(c1)) {
    return c1;
  }
  return 0;
}

// A_is_harakat returns true if 'c' is an Arabic Harakat character.
//     (harakat/tanween)
static bool A_is_harakat(int c)
{
  return c >= a_FATHATAN && c <= a_SUKUN;
}

// A_is_iso returns true if 'c' is an Arabic ISO-8859-6 character.
//     (alphabet/number/punctuation)
static bool A_is_iso(int c)
{
  return ((c >= a_HAMZA && c <= a_GHAIN)
          || (c >= a_TATWEEL && c <= a_HAMZA_BELOW)
          || c == a_MINI_ALEF);
}

// A_is_formb returns true if 'c' is an Arabic 10646-1 FormB character.
//     (alphabet/number/punctuation)
static bool A_is_formb(int c)
{
  return ((c >= a_s_FATHATAN && c <= a_s_DAMMATAN)
          || c == a_s_KASRATAN
          || (c >= a_s_FATHA && c <= a_f_LAM_ALEF)
          || c == a_BYTE_ORDER_MARK);
}

// A_is_ok returns true if 'c' is an Arabic 10646 (8859-6 or Form-B).
static bool A_is_ok(int c)
{
  return A_is_iso(c) || A_is_formb(c);
}

// A_is_valid returns true if 'c' is an Arabic 10646 (8859-6 or Form-B),
// with some exceptions/exclusions.
static bool A_is_valid(int c)
{
  return A_is_ok(c) && !A_is_special(c);
}

// A_is_special returns true if 'c' is not a special Arabic character.
// Specials don't adhere to most of the rules.
static bool A_is_special(int c)
{
  return c == a_HAMZA || c == a_s_HAMZA;
}