lib_str.lst
411 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
L 1 "..\..\uCOS-III\uC-LIB\lib_str.c"
N/*
N*********************************************************************************************************
N* uC/LIB
N* CUSTOM LIBRARY MODULES
N*
N* (c) Copyright 2004-2012; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/LIB is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* ASCII STRING MANAGEMENT
N*
N* Filename : lib_str.c
N* Version : V1.37.01
N* Programmer(s) : ITJ
N* BAN
N* JDH
N*********************************************************************************************************
N* Note(s) : (1) NO compiler-supplied standard library functions are used in library or product software.
N*
N* (a) ALL standard library functions are implemented in the custom library modules :
N*
N* (1) \<Custom Library Directory>\lib_*.*
N*
N* (2) \<Custom Library Directory>\Ports\<cpu>\<compiler>\lib*_a.*
N*
N* where
N* <Custom Library Directory> directory path for custom library software
N* <cpu> directory name for specific processor (CPU)
N* <compiler> directory name for specific compiler
N*
N* (b) Product-specific library functions are implemented in individual products.
N*
N*********************************************************************************************************
N* Notice(s) : (1) The Institute of Electrical and Electronics Engineers and The Open Group, have given
N* us permission to reprint portions of their documentation. Portions of this text are
N* reprinted and reproduced in electronic form from the IEEE Std 1003.1, 2004 Edition,
N* Standard for Information Technology -- Portable Operating System Interface (POSIX),
N* The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute
N* of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any
N* discrepancy between these versions and the original IEEE and The Open Group Standard,
N* the original IEEE and The Open Group Standard is the referee document. The original
N* Standard can be obtained online at http://www.opengroup.org/unix/online.html.
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* INCLUDE FILES
N*********************************************************************************************************
N*/
N
N#define MICRIUM_SOURCE
N#define LIB_STR_MODULE
N#include <lib_str.h>
L 1 "..\..\uCOS-III\uC-LIB\lib_str.h" 1
N/*
N*********************************************************************************************************
N* uC/LIB
N* CUSTOM LIBRARY MODULES
N*
N* (c) Copyright 2004-2012; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/LIB is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* ASCII STRING MANAGEMENT
N*
N* Filename : lib_str.h
N* Version : V1.37.01
N* Programmer(s) : ITJ
N* JDH
N*********************************************************************************************************
N* Note(s) : (1) NO compiler-supplied standard library functions are used in library or product software.
N*
N* (a) ALL standard library functions are implemented in the custom library modules :
N*
N* (1) \<Custom Library Directory>\lib_*.*
N*
N* (2) \<Custom Library Directory>\Ports\<cpu>\<compiler>\lib*_a.*
N*
N* where
N* <Custom Library Directory> directory path for custom library software
N* <cpu> directory name for specific processor (CPU)
N* <compiler> directory name for specific compiler
N*
N* (b) Product-specific library functions are implemented in individual products.
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE
N*
N* Note(s) : (1) This string library header file is protected from multiple pre-processor inclusion through
N* use of the string library module present pre-processor macro definition.
N*********************************************************************************************************
N*/
N
N#ifndef LIB_STR_MODULE_PRESENT /* See Note #1. */
N#define LIB_STR_MODULE_PRESENT
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ASCII STRING CONFIGURATION DEFINES
N*
N* Note(s) : (1) Some ASCII string configuration #define's MUST be available PRIOR to including any
N* application configuration (see 'INCLUDE FILES Note #1a').
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* STRING FLOATING POINT DEFINES
N*
N* Note(s) : (1) (a) (1) The maximum accuracy for 32-bit floating-point numbers :
N*
N*
N* Maximum Accuracy log [Internal-Base ^ (Number-Internal-Base-Digits)]
N* 32-bit Floating-point Number = -----------------------------------------------------
N* log [External-Base]
N*
N* log [2 ^ 24]
N* = --------------
N* log [10]
N*
N* < 7.225 Base-10 Digits
N*
N* where
N* Internal-Base Internal number base of floating-
N* point numbers (i.e. 2)
N* External-Base External number base of floating-
N* point numbers (i.e. 10)
N* Number-Internal-Base-Digits Number of internal number base
N* significant digits (i.e. 24)
N*
N* (2) Also, since some 32-bit floating-point calculations are converted to 32-bit
N* unsigned numbers, the maximum accuracy is limited to the maximum accuracy
N* for 32-bit unsigned numbers of 9 digits.
N*
N* (b) Some CPUs' &/or compilers' floating-point implementations MAY further reduce the
N* maximum accuracy.
N*********************************************************************************************************
N*/
N
N#define LIB_STR_FP_MAX_NBR_DIG_SIG_MIN 1u
N#define LIB_STR_FP_MAX_NBR_DIG_SIG_MAX 9u /* See Note #1a2. */
N#define LIB_STR_FP_MAX_NBR_DIG_SIG_DFLT 7u /* See Note #1a1. */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* INCLUDE FILES
N*
N* Note(s) : (1) The custom library software files are located in the following directories :
N*
N* (a) \<Your Product Application>\lib_cfg.h
N*
N* (b) \<Custom Library Directory>\lib_*.*
N*
N* where
N* <Your Product Application> directory path for Your Product's Application
N* <Custom Library Directory> directory path for custom library software
N*
N* (2) CPU-configuration software files are located in the following directories :
N*
N* (a) \<CPU-Compiler Directory>\cpu_*.*
N* (b) \<CPU-Compiler Directory>\<cpu>\<compiler>\cpu*.*
N*
N* where
N* <CPU-Compiler Directory> directory path for common CPU-compiler software
N* <cpu> directory name for specific processor (CPU)
N* <compiler> directory name for specific compiler
N*
N* (3) Compiler MUST be configured to include as additional include path directories :
N*
N* (a) '\<Your Product Application>\' directory See Note #1a
N*
N* (b) '\<Custom Library Directory>\' directory See Note #1b
N*
N* (c) (1) '\<CPU-Compiler Directory>\' directory See Note #2a
N* (2) '\<CPU-Compiler Directory>\<cpu>\<compiler>\' directory See Note #2b
N*
N* (4) NO compiler-supplied standard library functions SHOULD be used.
N*
N* #### The reference to standard library header files SHOULD be removed once all custom
N* library functions are implemented WITHOUT reference to ANY standard library function(s).
N*
N* See also 'STANDARD LIBRARY MACRO'S Note #1'.
N*********************************************************************************************************
N*/
N
N#include <cpu.h>
L 1 "..\..\uCOS-III\uC-CPU\ARM-Cortex-M4\RealView\cpu.h" 1
N/*
N*********************************************************************************************************
N* uC/CPU
N* CPU CONFIGURATION & PORT LAYER
N*
N* (c) Copyright 2004-2011; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/CPU is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* CPU PORT FILE
N*
N* ARM-Cortex-M4
N* RealView Development Suite
N* RealView Microcontroller Development Kit (MDK)
N* ARM Developer Suite (ADS)
N* Keil uVision
N*
N* Filename : cpu.h
N* Version : V1.29.01.00
N* Programmer(s) : JJL
N* BAN
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE
N*
N* Note(s) : (1) This CPU header file is protected from multiple pre-processor inclusion through use of
N* the CPU module present pre-processor macro definition.
N*********************************************************************************************************
N*/
N
N#ifndef CPU_MODULE_PRESENT /* See Note #1. */
N#define CPU_MODULE_PRESENT
N
N
N/*
N*********************************************************************************************************
N* CPU INCLUDE FILES
N*
N* Note(s) : (1) The following CPU files are located in the following directories :
N*
N* (a) \<Your Product Application>\cpu_cfg.h
N*
N* (b) (1) \<CPU-Compiler Directory>\cpu_def.h
N* (2) \<CPU-Compiler Directory>\<cpu>\<compiler>\cpu*.*
N*
N* where
N* <Your Product Application> directory path for Your Product's Application
N* <CPU-Compiler Directory> directory path for common CPU-compiler software
N* <cpu> directory name for specific CPU
N* <compiler> directory name for specific compiler
N*
N* (2) Compiler MUST be configured to include as additional include path directories :
N*
N* (a) '\<Your Product Application>\' directory See Note #1a
N*
N* (b) (1) '\<CPU-Compiler Directory>\' directory See Note #1b1
N* (2) '\<CPU-Compiler Directory>\<cpu>\<compiler>\' directory See Note #1b2
N*
N* (3) Since NO custom library modules are included, 'cpu.h' may ONLY use configurations from
N* CPU configuration file 'cpu_cfg.h' that do NOT reference any custom library definitions.
N*
N* In other words, 'cpu.h' may use 'cpu_cfg.h' configurations that are #define'd to numeric
N* constants or to NULL (i.e. NULL-valued #define's); but may NOT use configurations to
N* custom library #define's (e.g. DEF_DISABLED or DEF_ENABLED).
N*********************************************************************************************************
N*/
N
N#include <cpu_def.h>
L 1 "..\..\uCOS-III\uC-CPU\cpu_def.h" 1
N/*
N*********************************************************************************************************
N* uC/CPU
N* CPU CONFIGURATION & PORT LAYER
N*
N* (c) Copyright 2004-2011; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/CPU is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* CPU CONFIGURATION DEFINES
N*
N* Filename : cpu_def.h
N* Version : V1.29.01
N* Programmer(s) : ITJ
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE
N*
N* Note(s) : (1) This CPU definition header file is protected from multiple pre-processor inclusion
N* through use of the CPU definition module present pre-processor macro definition.
N*********************************************************************************************************
N*/
N
N#ifndef CPU_DEF_MODULE_PRESENT
N#define CPU_DEF_MODULE_PRESENT
N
N
N/*
N*********************************************************************************************************
N* CORE CPU MODULE VERSION NUMBER
N*
N* Note(s) : (1) (a) The core CPU module software version is denoted as follows :
N*
N* Vx.yy.zz
N*
N* where
N* V denotes 'Version' label
N* x denotes major software version revision number
N* yy denotes minor software version revision number
N* zz denotes sub-minor software version revision number
N*
N* (b) The software version label #define is formatted as follows :
N*
N* ver = x.yyzz * 100 * 100
N*
N* where
N* ver denotes software version number scaled as an integer value
N* x.yyzz denotes software version number, where the unscaled integer
N* portion denotes the major version number & the unscaled
N* fractional portion denotes the (concatenated) minor
N* version numbers
N*********************************************************************************************************
N*/
N
N#define CPU_CORE_VERSION 12901u /* See Note #1. */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CPU WORD CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_ADDR_SIZE & CPU_CFG_DATA_SIZE in 'cpu.h' with CPU's word sizes :
N*
N* CPU_WORD_SIZE_08 8-bit word size
N* CPU_WORD_SIZE_16 16-bit word size
N* CPU_WORD_SIZE_32 32-bit word size
N* CPU_WORD_SIZE_64 64-bit word size
N*
N* (2) Configure CPU_CFG_ENDIAN_TYPE in 'cpu.h' with CPU's data-word-memory order :
N*
N* (a) CPU_ENDIAN_TYPE_BIG Big- endian word order (CPU words' most significant
N* octet @ lowest memory address)
N* (b) CPU_ENDIAN_TYPE_LITTLE Little-endian word order (CPU words' least significant
N* octet @ lowest memory address)
N*********************************************************************************************************
N*/
N
N /* ---------------------- CPU WORD SIZE ----------------------- */
N#define CPU_WORD_SIZE_08 1 /* 8-bit word size (in octets). */
N#define CPU_WORD_SIZE_16 2 /* 16-bit word size (in octets). */
N#define CPU_WORD_SIZE_32 4 /* 32-bit word size (in octets). */
N#define CPU_WORD_SIZE_64 8 /* 64-bit word size (in octets). */
N
N
N /* ------------------ CPU WORD-ENDIAN ORDER ------------------- */
N#define CPU_ENDIAN_TYPE_NONE 0u
N#define CPU_ENDIAN_TYPE_BIG 1u /* Big- endian word order (see Note #1a). */
N#define CPU_ENDIAN_TYPE_LITTLE 2u /* Little-endian word order (see Note #1b). */
N
N
N/*
N*********************************************************************************************************
N* CPU STACK CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_STK_GROWTH in 'cpu.h' with CPU's stack growth order :
N*
N* (a) CPU_STK_GROWTH_LO_TO_HI CPU stack pointer increments to the next higher stack
N* memory address after data is pushed onto the stack
N* (b) CPU_STK_GROWTH_HI_TO_LO CPU stack pointer decrements to the next lower stack
N* memory address after data is pushed onto the stack
N*********************************************************************************************************
N*/
N
N /* ------------------ CPU STACK GROWTH ORDER ------------------ */
N#define CPU_STK_GROWTH_NONE 0u
N#define CPU_STK_GROWTH_LO_TO_HI 1u /* CPU stk incs towards higher mem addrs (see Note #1a). */
N#define CPU_STK_GROWTH_HI_TO_LO 2u /* CPU stk decs towards lower mem addrs (see Note #1b). */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CRITICAL SECTION CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_CRITICAL_METHOD with CPU's/compiler's critical section method :
N*
N* Enter/Exit critical sections by ...
N*
N* CPU_CRITICAL_METHOD_INT_DIS_EN Disable/Enable interrupts
N* CPU_CRITICAL_METHOD_STATUS_STK Push/Pop interrupt status onto stack
N* CPU_CRITICAL_METHOD_STATUS_LOCAL Save/Restore interrupt status to local variable
N*
N* (a) CPU_CRITICAL_METHOD_INT_DIS_EN is NOT a preferred method since it does NOT support
N* multiple levels of interrupts. However, with some CPUs/compilers, this is the only
N* available method.
N*
N* (b) CPU_CRITICAL_METHOD_STATUS_STK is one preferred method since it supports multiple
N* levels of interrupts. However, this method assumes that the compiler provides C-level
N* &/or assembly-level functionality for the following :
N*
N* ENTER CRITICAL SECTION :
N* (1) Push/save interrupt status onto a local stack
N* (2) Disable interrupts
N*
N* EXIT CRITICAL SECTION :
N* (3) Pop/restore interrupt status from a local stack
N*
N* (c) CPU_CRITICAL_METHOD_STATUS_LOCAL is one preferred method since it supports multiple
N* levels of interrupts. However, this method assumes that the compiler provides C-level
N* &/or assembly-level functionality for the following :
N*
N* ENTER CRITICAL SECTION :
N* (1) Save interrupt status into a local variable
N* (2) Disable interrupts
N*
N* EXIT CRITICAL SECTION :
N* (3) Restore interrupt status from a local variable
N*
N* (2) Critical section macro's most likely require inline assembly. If the compiler does NOT
N* allow inline assembly in C source files, critical section macro's MUST call an assembly
N* subroutine defined in a 'cpu_a.asm' file located in the following software directory :
N*
N* \<CPU-Compiler Directory>\<cpu>\<compiler>\
N*
X
N* where
N* <CPU-Compiler Directory> directory path for common CPU-compiler software
N* <cpu> directory name for specific CPU
N* <compiler> directory name for specific compiler
N*
N* (3) (a) To save/restore interrupt status, a local variable 'cpu_sr' of type 'CPU_SR' MAY need
N* to be declared (e.g. if 'CPU_CRITICAL_METHOD_STATUS_LOCAL' method is configured).
N*
N* (1) 'cpu_sr' local variable SHOULD be declared via the CPU_SR_ALLOC() macro which,
N* if used, MUST be declared following ALL other local variables (see any 'cpu.h
N* CRITICAL SECTION CONFIGURATION Note #3a1').
N*
N* Example :
N*
N* void Fnct (void)
N* {
N* CPU_INT08U val_08;
N* CPU_INT16U val_16;
N* CPU_INT32U val_32;
N* CPU_SR_ALLOC(); MUST be declared after ALL other local variables
N* :
N* :
N* }
N*
N* (b) Configure 'CPU_SR' data type with the appropriate-sized CPU data type large enough to
N* completely store the CPU's/compiler's status word.
N*********************************************************************************************************
N*/
N
N /* --------------- CPU CRITICAL SECTION METHODS --------------- */
N#define CPU_CRITICAL_METHOD_NONE 0u /* */
N#define CPU_CRITICAL_METHOD_INT_DIS_EN 1u /* DIS/EN ints (see Note #1a). */
N#define CPU_CRITICAL_METHOD_STATUS_STK 2u /* Push/Pop int status onto stk (see Note #1b). */
N#define CPU_CRITICAL_METHOD_STATUS_LOCAL 3u /* Save/Restore int status to local var (see Note #1c). */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* MODULE END
N*
N* Note(s) : (1) See 'cpu_def.h MODULE'.
N*********************************************************************************************************
N*/
N
N#endif /* End of CPU def module include. */
N
L 88 "..\..\uCOS-III\uC-CPU\ARM-Cortex-M4\RealView\cpu.h" 2
N#include <cpu_cfg.h> /* See Note #3. */
L 1 "..\..\User\cpu_cfg.h" 1
N/*
N*********************************************************************************************************
N* uC/CPU
N* CPU CONFIGURATION & PORT LAYER
N*
N* (c) Copyright 2004-2011; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/CPU is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* CPU CONFIGURATION FILE
N*
N* TEMPLATE
N*
N* Filename : cpu_cfg.h
N* Version : V1.29.01
N* Programmer(s) : SR
N* ITJ
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE
N*********************************************************************************************************
N*/
N
N#ifndef CPU_CFG_MODULE_PRESENT
N#define CPU_CFG_MODULE_PRESENT
N
N
N/*
N*********************************************************************************************************
N* CPU NAME CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_NAME_EN to enable/disable CPU host name feature :
N*
N* (a) CPU host name storage
N* (b) CPU host name API functions
N*
N* (2) Configure CPU_CFG_NAME_SIZE with the desired ASCII string size of the CPU host name,
N* including the terminating NULL character.
N*
N* See also 'cpu_core.h GLOBAL VARIABLES Note #1'.
N*********************************************************************************************************
N*/
N
N /* Configure CPU host name feature (see Note #1) : */
N#define CPU_CFG_NAME_EN DEF_ENABLED
N /* DEF_DISABLED CPU host name DISABLED */
N /* DEF_ENABLED CPU host name ENABLED */
N
N /* Configure CPU host name ASCII string size ... */
N#define CPU_CFG_NAME_SIZE 16 /* ... (see Note #2). */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CPU TIMESTAMP CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_TS_xx_EN to enable/disable CPU timestamp features :
N*
N* (a) CPU_CFG_TS_32_EN enable/disable 32-bit CPU timestamp feature
N* (b) CPU_CFG_TS_64_EN enable/disable 64-bit CPU timestamp feature
N*
N* (2) (a) Configure CPU_CFG_TS_TMR_SIZE with the CPU timestamp timer's word size :
N*
N* CPU_WORD_SIZE_08 8-bit word size
N* CPU_WORD_SIZE_16 16-bit word size
N* CPU_WORD_SIZE_32 32-bit word size
N* CPU_WORD_SIZE_64 64-bit word size
N*
N* (b) If the size of the CPU timestamp timer is not a binary multiple of 8-bit octets
N* (e.g. 20-bits or even 24-bits), then the next lower, binary-multiple octet word
N* size SHOULD be configured (e.g. to 16-bits). However, the minimum supported word
N* size for CPU timestamp timers is 8-bits.
N*
N* See also 'cpu_core.h FUNCTION PROTOTYPES CPU_TS_TmrRd() Note #2a'.
N*********************************************************************************************************
N*/
N
N /* Configure CPU timestamp features (see Note #1) : */
N#define CPU_CFG_TS_32_EN DEF_ENABLED
N#define CPU_CFG_TS_64_EN DEF_DISABLED
N /* DEF_DISABLED CPU timestamps DISABLED */
N /* DEF_ENABLED CPU timestamps ENABLED */
N
N /* Configure CPU timestamp timer word size ... */
N /* ... (see Note #2) : */
N#define CPU_CFG_TS_TMR_SIZE CPU_WORD_SIZE_32
N
N
N/*
N*********************************************************************************************************
N* CPU INTERRUPTS DISABLED TIME MEASUREMENT CONFIGURATION
N*
N* Note(s) : (1) (a) Configure CPU_CFG_INT_DIS_MEAS_EN to enable/disable measuring CPU's interrupts
N* disabled time :
N*
N* (a) Enabled, if CPU_CFG_INT_DIS_MEAS_EN #define'd in 'cpu_cfg.h'
N*
N* (b) Disabled, if CPU_CFG_INT_DIS_MEAS_EN NOT #define'd in 'cpu_cfg.h'
N*
N* See also 'cpu_core.h FUNCTION PROTOTYPES Note #1'.
N*
N* (b) Configure CPU_CFG_INT_DIS_MEAS_OVRHD_NBR with the number of times to measure &
N* average the interrupts disabled time measurements overhead.
N*
N* Recommend a single (1) overhead time measurement, even for instruction-cache-enabled
N* CPUs, since critical sections are NOT typically called within instruction-cached loops.
N* Thus a single non-cached/non-averaged time measurement is a more realistic overhead
N* for the majority of non-cached interrupts disabled time measurements.
N*
N* See also 'cpu_core.c CPU_IntDisMeasInit() Note #3a'.
N*********************************************************************************************************
N*/
N
N#if 0 /* Configure CPU interrupts disabled time ... */
S#define CPU_CFG_INT_DIS_MEAS_EN /* ... measurements feature (see Note #1a). */
N#endif
N
N /* Configure number of interrupts disabled overhead ... */
N#define CPU_CFG_INT_DIS_MEAS_OVRHD_NBR 1u /* ... time measurements (see Note #1b). */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CPU COUNT ZEROS CONFIGURATION
N*
N* Note(s) : (1) (a) Configure CPU_CFG_LEAD_ZEROS_ASM_PRESENT to define count leading zeros bits
N* function(s) in :
N*
N* (1) 'cpu_a.asm', if CPU_CFG_LEAD_ZEROS_ASM_PRESENT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable assembly-optimized function(s)
N*
N* (2) 'cpu_core.c', if CPU_CFG_LEAD_ZEROS_ASM_PRESENT NOT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable C-source-optimized function(s) otherwise
N*
N* (b) Configure CPU_CFG_TRAIL_ZEROS_ASM_PRESENT to define count trailing zeros bits
N* function(s) in :
N*
N* (1) 'cpu_a.asm', if CPU_CFG_TRAIL_ZEROS_ASM_PRESENT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable assembly-optimized function(s)
N*
N* (2) 'cpu_core.c', if CPU_CFG_TRAIL_ZEROS_ASM_PRESENT NOT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable C-source-optimized function(s) otherwise
N*********************************************************************************************************
N*/
N
N#if 1 /* Configure CPU count leading zeros bits ... */
N#define CPU_CFG_LEAD_ZEROS_ASM_PRESENT /* ... assembly-version (see Note #1a). */
N#endif
N
N#if 0 /* Configure CPU count trailing zeros bits ... */
S#define CPU_CFG_TRAIL_ZEROS_ASM_PRESENT /* ... assembly-version (see Note #1b). */
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* MODULE END
N*********************************************************************************************************
N*/
N
N#endif /* End of CPU cfg module include. */
N
L 89 "..\..\uCOS-III\uC-CPU\ARM-Cortex-M4\RealView\cpu.h" 2
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CONFIGURE STANDARD DATA TYPES
N*
N* Note(s) : (1) Configure standard data types according to CPU-/compiler-specifications.
N*
N* (2) (a) (1) 'CPU_FNCT_VOID' data type defined to replace the commonly-used function pointer
N* data type of a pointer to a function which returns void & has no arguments.
N*
N* (2) Example function pointer usage :
N*
N* CPU_FNCT_VOID FnctName;
N*
N* FnctName();
N*
N* (b) (1) 'CPU_FNCT_PTR' data type defined to replace the commonly-used function pointer
N* data type of a pointer to a function which returns void & has a single void
N* pointer argument.
N*
N* (2) Example function pointer usage :
N*
N* CPU_FNCT_PTR FnctName;
N* void *p_obj
N*
N* FnctName(p_obj);
N*********************************************************************************************************
N*/
N
Ntypedef void CPU_VOID;
Ntypedef char CPU_CHAR; /* 8-bit character */
Ntypedef unsigned char CPU_BOOLEAN; /* 8-bit boolean or logical */
Ntypedef unsigned char CPU_INT08U; /* 8-bit unsigned integer */
Ntypedef signed char CPU_INT08S; /* 8-bit signed integer */
Ntypedef unsigned short CPU_INT16U; /* 16-bit unsigned integer */
Ntypedef signed short CPU_INT16S; /* 16-bit signed integer */
Ntypedef unsigned int CPU_INT32U; /* 32-bit unsigned integer */
Ntypedef signed int CPU_INT32S; /* 32-bit signed integer */
Ntypedef unsigned long long CPU_INT64U; /* 64-bit unsigned integer */
Ntypedef signed long long CPU_INT64S; /* 64-bit signed integer */
N
Ntypedef float CPU_FP32; /* 32-bit floating point */
Ntypedef double CPU_FP64; /* 64-bit floating point */
N
N
Ntypedef volatile CPU_INT08U CPU_REG08; /* 8-bit register */
Ntypedef volatile CPU_INT16U CPU_REG16; /* 16-bit register */
Ntypedef volatile CPU_INT32U CPU_REG32; /* 32-bit register */
Ntypedef volatile CPU_INT64U CPU_REG64; /* 64-bit register */
N
N
Ntypedef void (*CPU_FNCT_VOID)(void); /* See Note #2a. */
Ntypedef void (*CPU_FNCT_PTR )(void *p_obj); /* See Note #2b. */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CPU WORD CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_ADDR_SIZE, CPU_CFG_DATA_SIZE, & CPU_CFG_DATA_SIZE_MAX with CPU's &/or
N* compiler's word sizes :
N*
N* CPU_WORD_SIZE_08 8-bit word size
N* CPU_WORD_SIZE_16 16-bit word size
N* CPU_WORD_SIZE_32 32-bit word size
N* CPU_WORD_SIZE_64 64-bit word size
N*
N* (2) Configure CPU_CFG_ENDIAN_TYPE with CPU's data-word-memory order :
N*
N* (a) CPU_ENDIAN_TYPE_BIG Big- endian word order (CPU words' most significant
N* octet @ lowest memory address)
N* (b) CPU_ENDIAN_TYPE_LITTLE Little-endian word order (CPU words' least significant
N* octet @ lowest memory address)
N*********************************************************************************************************
N*/
N
N /* Define CPU word sizes (see Note #1) : */
N#define CPU_CFG_ADDR_SIZE CPU_WORD_SIZE_32 /* Defines CPU address word size (in octets). */
N#define CPU_CFG_DATA_SIZE CPU_WORD_SIZE_32 /* Defines CPU data word size (in octets). */
N#define CPU_CFG_DATA_SIZE_MAX CPU_WORD_SIZE_64 /* Defines CPU maximum word size (in octets). */
N
N#define CPU_CFG_ENDIAN_TYPE CPU_ENDIAN_TYPE_LITTLE /* Defines CPU data word-memory order (see Note #2). */
N
N
N/*
N*********************************************************************************************************
N* CONFIGURE CPU ADDRESS & DATA TYPES
N*********************************************************************************************************
N*/
N
N /* CPU address type based on address bus size. */
N#if (CPU_CFG_ADDR_SIZE == CPU_WORD_SIZE_32)
X#if (4 == 4)
Ntypedef CPU_INT32U CPU_ADDR;
N#elif (CPU_CFG_ADDR_SIZE == CPU_WORD_SIZE_16)
Stypedef CPU_INT16U CPU_ADDR;
S#else
Stypedef CPU_INT08U CPU_ADDR;
N#endif
N
N /* CPU data type based on data bus size. */
N#if (CPU_CFG_DATA_SIZE == CPU_WORD_SIZE_32)
X#if (4 == 4)
Ntypedef CPU_INT32U CPU_DATA;
N#elif (CPU_CFG_DATA_SIZE == CPU_WORD_SIZE_16)
Stypedef CPU_INT16U CPU_DATA;
S#else
Stypedef CPU_INT08U CPU_DATA;
N#endif
N
N
Ntypedef CPU_DATA CPU_ALIGN; /* Defines CPU data-word-alignment size. */
Ntypedef CPU_ADDR CPU_SIZE_T; /* Defines CPU standard 'size_t' size. */
N
N
N/*
N*********************************************************************************************************
N* CPU STACK CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_STK_GROWTH in 'cpu.h' with CPU's stack growth order :
N*
N* (a) CPU_STK_GROWTH_LO_TO_HI CPU stack pointer increments to the next higher stack
N* memory address after data is pushed onto the stack
N* (b) CPU_STK_GROWTH_HI_TO_LO CPU stack pointer decrements to the next lower stack
N* memory address after data is pushed onto the stack
N*********************************************************************************************************
N*/
N
N#define CPU_CFG_STK_GROWTH CPU_STK_GROWTH_HI_TO_LO /* Defines CPU stack growth order (see Note #1). */
N
Ntypedef CPU_INT32U CPU_STK; /* Defines CPU stack word size (in octets). */
Ntypedef CPU_ADDR CPU_STK_SIZE; /* Defines CPU stack size (in number of CPU_STKs). */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CRITICAL SECTION CONFIGURATION
N*
N* Note(s) : (1) Configure CPU_CFG_CRITICAL_METHOD with CPU's/compiler's critical section method :
N*
N* Enter/Exit critical sections by ...
N*
N* CPU_CRITICAL_METHOD_INT_DIS_EN Disable/Enable interrupts
N* CPU_CRITICAL_METHOD_STATUS_STK Push/Pop interrupt status onto stack
N* CPU_CRITICAL_METHOD_STATUS_LOCAL Save/Restore interrupt status to local variable
N*
N* (a) CPU_CRITICAL_METHOD_INT_DIS_EN is NOT a preferred method since it does NOT support
N* multiple levels of interrupts. However, with some CPUs/compilers, this is the only
N* available method.
N*
N* (b) CPU_CRITICAL_METHOD_STATUS_STK is one preferred method since it supports multiple
N* levels of interrupts. However, this method assumes that the compiler provides C-level
N* &/or assembly-level functionality for the following :
N*
N* ENTER CRITICAL SECTION :
N* (1) Push/save interrupt status onto a local stack
N* (2) Disable interrupts
N*
N* EXIT CRITICAL SECTION :
N* (3) Pop/restore interrupt status from a local stack
N*
N* (c) CPU_CRITICAL_METHOD_STATUS_LOCAL is one preferred method since it supports multiple
N* levels of interrupts. However, this method assumes that the compiler provides C-level
N* &/or assembly-level functionality for the following :
N*
N* ENTER CRITICAL SECTION :
N* (1) Save interrupt status into a local variable
N* (2) Disable interrupts
N*
N* EXIT CRITICAL SECTION :
N* (3) Restore interrupt status from a local variable
N*
N* (2) Critical section macro's most likely require inline assembly. If the compiler does NOT
N* allow inline assembly in C source files, critical section macro's MUST call an assembly
N* subroutine defined in a 'cpu_a.asm' file located in the following software directory :
N*
N* \<CPU-Compiler Directory>\<cpu>\<compiler>\
N*
X
N* where
N* <CPU-Compiler Directory> directory path for common CPU-compiler software
N* <cpu> directory name for specific CPU
N* <compiler> directory name for specific compiler
N*
N* (3) (a) To save/restore interrupt status, a local variable 'cpu_sr' of type 'CPU_SR' MAY need
N* to be declared (e.g. if 'CPU_CRITICAL_METHOD_STATUS_LOCAL' method is configured).
N*
N* (1) 'cpu_sr' local variable SHOULD be declared via the CPU_SR_ALLOC() macro which, if
N* used, MUST be declared following ALL other local variables.
N*
N* Example :
N*
N* void Fnct (void)
N* {
N* CPU_INT08U val_08;
N* CPU_INT16U val_16;
N* CPU_INT32U val_32;
N* CPU_SR_ALLOC(); MUST be declared after ALL other local variables
N* :
N* :
N* }
N*
N* (b) Configure 'CPU_SR' data type with the appropriate-sized CPU data type large enough to
N* completely store the CPU's/compiler's status word.
N*********************************************************************************************************
N*/
N/*$PAGE*/
N /* Configure CPU critical method (see Note #1) : */
N#define CPU_CFG_CRITICAL_METHOD CPU_CRITICAL_METHOD_STATUS_LOCAL
N
Ntypedef CPU_INT32U CPU_SR; /* Defines CPU status register size (see Note #3b). */
N
N /* Allocates CPU status register word (see Note #3a). */
N#if (CPU_CFG_CRITICAL_METHOD == CPU_CRITICAL_METHOD_STATUS_LOCAL)
X#if (3u == 3u)
N#define CPU_SR_ALLOC() CPU_SR cpu_sr = (CPU_SR)0
N#else
S#define CPU_SR_ALLOC()
N#endif
N
N
N
N#define CPU_INT_DIS() do { cpu_sr = CPU_SR_Save(); } while (0) /* Save CPU status word & disable interrupts.*/
N#define CPU_INT_EN() do { CPU_SR_Restore(cpu_sr); } while (0) /* Restore CPU status word. */
N
N
N#ifdef CPU_CFG_INT_DIS_MEAS_EN
S /* Disable interrupts, ... */
S /* & start interrupts disabled time measurement.*/
S#define CPU_CRITICAL_ENTER() do { CPU_INT_DIS(); \
S CPU_IntDisMeasStart(); } while (0)
X#define CPU_CRITICAL_ENTER() do { CPU_INT_DIS(); CPU_IntDisMeasStart(); } while (0)
S /* Stop & measure interrupts disabled time, */
S /* ... & re-enable interrupts. */
S#define CPU_CRITICAL_EXIT() do { CPU_IntDisMeasStop(); \
S CPU_INT_EN(); } while (0)
X#define CPU_CRITICAL_EXIT() do { CPU_IntDisMeasStop(); CPU_INT_EN(); } while (0)
S
N#else
N
N#define CPU_CRITICAL_ENTER() do { CPU_INT_DIS(); } while (0) /* Disable interrupts. */
N#define CPU_CRITICAL_EXIT() do { CPU_INT_EN(); } while (0) /* Re-enable interrupts. */
N
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CPU COUNT ZEROS CONFIGURATION
N*
N* Note(s) : (1) (a) Configure CPU_CFG_LEAD_ZEROS_ASM_PRESENT to define count leading zeros bits
N* function(s) in :
N*
N* (1) 'cpu_a.asm', if CPU_CFG_LEAD_ZEROS_ASM_PRESENT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable assembly-optimized function(s)
N*
N* (2) 'cpu_core.c', if CPU_CFG_LEAD_ZEROS_ASM_PRESENT NOT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable C-source-optimized function(s) otherwise
N*
N* (b) Configure CPU_CFG_TRAIL_ZEROS_ASM_PRESENT to define count trailing zeros bits
N* function(s) in :
N*
N* (1) 'cpu_a.asm', if CPU_CFG_TRAIL_ZEROS_ASM_PRESENT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable assembly-optimized function(s)
N*
N* (2) 'cpu_core.c', if CPU_CFG_TRAIL_ZEROS_ASM_PRESENT NOT #define'd in 'cpu.h'/
N* 'cpu_cfg.h' to enable C-source-optimized function(s) otherwise
N*********************************************************************************************************
N*/
N
N /* Configure CPU count leading zeros bits ... */
N#define CPU_CFG_LEAD_ZEROS_ASM_PRESENT /* ... assembly-version (see Note #1a). */
N
N /* Configure CPU count trailing zeros bits ... */
N#define CPU_CFG_TRAIL_ZEROS_ASM_PRESENT /* ... assembly-version (see Note #1b). */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* FUNCTION PROTOTYPES
N*********************************************************************************************************
N*/
N
Nvoid CPU_IntDis (void);
Nvoid CPU_IntEn (void);
N
Nvoid CPU_IntSrcDis (CPU_INT08U pos);
Nvoid CPU_IntSrcEn (CPU_INT08U pos);
Nvoid CPU_IntSrcPendClr(CPU_INT08U pos);
NCPU_INT16S CPU_IntSrcPrioGet(CPU_INT08U pos);
Nvoid CPU_IntSrcPrioSet(CPU_INT08U pos,
N CPU_INT08U prio);
N
N
NCPU_SR CPU_SR_Save (void);
Nvoid CPU_SR_Restore (CPU_SR cpu_sr);
N
N
Nvoid CPU_WaitForInt (void);
Nvoid CPU_WaitForExcept(void);
N
N
NCPU_DATA CPU_RevBits (CPU_DATA val);
N
Nvoid CPU_BitBandClr (CPU_ADDR addr,
N CPU_INT08U bit_nbr);
Nvoid CPU_BitBandSet (CPU_ADDR addr,
N CPU_INT08U bit_nbr);
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* INTERRUPT SOURCES
N*********************************************************************************************************
N*/
N
N#define CPU_INT_STK_PTR 0u
N#define CPU_INT_RESET 1u
N#define CPU_INT_NMI 2u
N#define CPU_INT_HFAULT 3u
N#define CPU_INT_MEM 4u
N#define CPU_INT_BUSFAULT 5u
N#define CPU_INT_USAGEFAULT 6u
N#define CPU_INT_RSVD_07 7u
N#define CPU_INT_RSVD_08 8u
N#define CPU_INT_RSVD_09 9u
N#define CPU_INT_RSVD_10 10u
N#define CPU_INT_SVCALL 11u
N#define CPU_INT_DBGMON 12u
N#define CPU_INT_RSVD_13 13u
N#define CPU_INT_PENDSV 14u
N#define CPU_INT_SYSTICK 15u
N#define CPU_INT_EXT0 16u
N
N/*
N*********************************************************************************************************
N* CPU REGISTERS
N*********************************************************************************************************
N*/
N
N#define CPU_REG_NVIC_NVIC (*((CPU_REG32 *)(0xE000E004))) /* Int Ctrl'er Type Reg. */
N#define CPU_REG_NVIC_ST_CTRL (*((CPU_REG32 *)(0xE000E010))) /* SysTick Ctrl & Status Reg. */
N#define CPU_REG_NVIC_ST_RELOAD (*((CPU_REG32 *)(0xE000E014))) /* SysTick Reload Value Reg. */
N#define CPU_REG_NVIC_ST_CURRENT (*((CPU_REG32 *)(0xE000E018))) /* SysTick Current Value Reg. */
N#define CPU_REG_NVIC_ST_CAL (*((CPU_REG32 *)(0xE000E01C))) /* SysTick Calibration Value Reg. */
N
N#define CPU_REG_NVIC_SETEN(n) (*((CPU_REG32 *)(0xE000E100 + (n) * 4u))) /* IRQ Set En Reg. */
N#define CPU_REG_NVIC_CLREN(n) (*((CPU_REG32 *)(0xE000E180 + (n) * 4u))) /* IRQ Clr En Reg. */
N#define CPU_REG_NVIC_SETPEND(n) (*((CPU_REG32 *)(0xE000E200 + (n) * 4u))) /* IRQ Set Pending Reg. */
N#define CPU_REG_NVIC_CLRPEND(n) (*((CPU_REG32 *)(0xE000E280 + (n) * 4u))) /* IRQ Clr Pending Reg. */
N#define CPU_REG_NVIC_ACTIVE(n) (*((CPU_REG32 *)(0xE000E300 + (n) * 4u))) /* IRQ Active Reg. */
N#define CPU_REG_NVIC_PRIO(n) (*((CPU_REG32 *)(0xE000E400 + (n) * 4u))) /* IRQ Prio Reg. */
N
N#define CPU_REG_NVIC_CPUID (*((CPU_REG32 *)(0xE000ED00))) /* CPUID Base Reg. */
N#define CPU_REG_NVIC_ICSR (*((CPU_REG32 *)(0xE000ED04))) /* Int Ctrl State Reg. */
N#define CPU_REG_NVIC_VTOR (*((CPU_REG32 *)(0xE000ED08))) /* Vect Tbl Offset Reg. */
N#define CPU_REG_NVIC_AIRCR (*((CPU_REG32 *)(0xE000ED0C))) /* App Int/Reset Ctrl Reg. */
N#define CPU_REG_NVIC_SCR (*((CPU_REG32 *)(0xE000ED10))) /* System Ctrl Reg. */
N#define CPU_REG_NVIC_CCR (*((CPU_REG32 *)(0xE000ED14))) /* Cfg Ctrl Reg. */
N#define CPU_REG_NVIC_SHPRI1 (*((CPU_REG32 *)(0xE000ED18))) /* System Handlers 4 to 7 Prio. */
N#define CPU_REG_NVIC_SHPRI2 (*((CPU_REG32 *)(0xE000ED1C))) /* System Handlers 8 to 11 Prio. */
N#define CPU_REG_NVIC_SHPRI3 (*((CPU_REG32 *)(0xE000ED20))) /* System Handlers 12 to 15 Prio. */
N#define CPU_REG_NVIC_SHCSR (*((CPU_REG32 *)(0xE000ED24))) /* System Handler Ctrl & State Reg. */
N#define CPU_REG_NVIC_CFSR (*((CPU_REG32 *)(0xE000ED28))) /* Configurable Fault Status Reg. */
N#define CPU_REG_NVIC_HFSR (*((CPU_REG32 *)(0xE000ED2C))) /* Hard Fault Status Reg. */
N#define CPU_REG_NVIC_DFSR (*((CPU_REG32 *)(0xE000ED30))) /* Debug Fault Status Reg. */
N#define CPU_REG_NVIC_MMFAR (*((CPU_REG32 *)(0xE000ED34))) /* Mem Manage Addr Reg. */
N#define CPU_REG_NVIC_BFAR (*((CPU_REG32 *)(0xE000ED38))) /* Bus Fault Addr Reg. */
N#define CPU_REG_NVIC_AFSR (*((CPU_REG32 *)(0xE000ED3C))) /* Aux Fault Status Reg. */
N
N#define CPU_REG_NVIC_PFR0 (*((CPU_REG32 *)(0xE000ED40))) /* Processor Feature Reg 0. */
N#define CPU_REG_NVIC_PFR1 (*((CPU_REG32 *)(0xE000ED44))) /* Processor Feature Reg 1. */
N#define CPU_REG_NVIC_DFR0 (*((CPU_REG32 *)(0xE000ED48))) /* Debug Feature Reg 0. */
N#define CPU_REG_NVIC_AFR0 (*((CPU_REG32 *)(0xE000ED4C))) /* Aux Feature Reg 0. */
N#define CPU_REG_NVIC_MMFR0 (*((CPU_REG32 *)(0xE000ED50))) /* Memory Model Feature Reg 0. */
N#define CPU_REG_NVIC_MMFR1 (*((CPU_REG32 *)(0xE000ED54))) /* Memory Model Feature Reg 1. */
N#define CPU_REG_NVIC_MMFR2 (*((CPU_REG32 *)(0xE000ED58))) /* Memory Model Feature Reg 2. */
N#define CPU_REG_NVIC_MMFR3 (*((CPU_REG32 *)(0xE000ED5C))) /* Memory Model Feature Reg 3. */
N#define CPU_REG_NVIC_ISAFR0 (*((CPU_REG32 *)(0xE000ED60))) /* ISA Feature Reg 0. */
N#define CPU_REG_NVIC_ISAFR1 (*((CPU_REG32 *)(0xE000ED64))) /* ISA Feature Reg 1. */
N#define CPU_REG_NVIC_ISAFR2 (*((CPU_REG32 *)(0xE000ED68))) /* ISA Feature Reg 2. */
N#define CPU_REG_NVIC_ISAFR3 (*((CPU_REG32 *)(0xE000ED6C))) /* ISA Feature Reg 3. */
N#define CPU_REG_NVIC_ISAFR4 (*((CPU_REG32 *)(0xE000ED70))) /* ISA Feature Reg 4. */
N#define CPU_REG_NVIC_SW_TRIG (*((CPU_REG32 *)(0xE000EF00))) /* Software Trigger Int Reg. */
N
N#define CPU_REG_MPU_TYPE (*((CPU_REG32 *)(0xE000ED90))) /* MPU Type Reg. */
N#define CPU_REG_MPU_CTRL (*((CPU_REG32 *)(0xE000ED94))) /* MPU Ctrl Reg. */
N#define CPU_REG_MPU_REG_NBR (*((CPU_REG32 *)(0xE000ED98))) /* MPU Region Nbr Reg. */
N#define CPU_REG_MPU_REG_BASE (*((CPU_REG32 *)(0xE000ED9C))) /* MPU Region Base Addr Reg. */
N#define CPU_REG_MPU_REG_ATTR (*((CPU_REG32 *)(0xE000EDA0))) /* MPU Region Attrib & Size Reg. */
N
N#define CPU_REG_DBG_CTRL (*((CPU_REG32 *)(0xE000EDF0))) /* Debug Halting Ctrl & Status Reg. */
N#define CPU_REG_DBG_SELECT (*((CPU_REG32 *)(0xE000EDF4))) /* Debug Core Reg Selector Reg. */
N#define CPU_REG_DBG_DATA (*((CPU_REG32 *)(0xE000EDF8))) /* Debug Core Reg Data Reg. */
N#define CPU_REG_DBG_INT (*((CPU_REG32 *)(0xE000EDFC))) /* Debug Except & Monitor Ctrl Reg. */
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CPU REGISTER BITS
N*********************************************************************************************************
N*/
N
N /* ---------- SYSTICK CTRL & STATUS REG BITS ---------- */
N#define CPU_REG_NVIC_ST_CTRL_COUNTFLAG 0x00010000
N#define CPU_REG_NVIC_ST_CTRL_CLKSOURCE 0x00000004
N#define CPU_REG_NVIC_ST_CTRL_TICKINT 0x00000002
N#define CPU_REG_NVIC_ST_CTRL_ENABLE 0x00000001
N
N
N /* -------- SYSTICK CALIBRATION VALUE REG BITS -------- */
N#define CPU_REG_NVIC_ST_CAL_NOREF 0x80000000
N#define CPU_REG_NVIC_ST_CAL_SKEW 0x40000000
N
N /* -------------- INT CTRL STATE REG BITS ------------- */
N#define CPU_REG_NVIC_ICSR_NMIPENDSET 0x80000000
N#define CPU_REG_NVIC_ICSR_PENDSVSET 0x10000000
N#define CPU_REG_NVIC_ICSR_PENDSVCLR 0x08000000
N#define CPU_REG_NVIC_ICSR_PENDSTSET 0x04000000
N#define CPU_REG_NVIC_ICSR_PENDSTCLR 0x02000000
N#define CPU_REG_NVIC_ICSR_ISRPREEMPT 0x00800000
N#define CPU_REG_NVIC_ICSR_ISRPENDING 0x00400000
N#define CPU_REG_NVIC_ICSR_RETTOBASE 0x00000800
N
N /* ------------- VECT TBL OFFSET REG BITS ------------- */
N#define CPU_REG_NVIC_VTOR_TBLBASE 0x20000000
N
N /* ------------ APP INT/RESET CTRL REG BITS ----------- */
N#define CPU_REG_NVIC_AIRCR_ENDIANNESS 0x00008000
N#define CPU_REG_NVIC_AIRCR_SYSRESETREQ 0x00000004
N#define CPU_REG_NVIC_AIRCR_VECTCLRACTIVE 0x00000002
N#define CPU_REG_NVIC_AIRCR_VECTRESET 0x00000001
N
N /* --------------- SYSTEM CTRL REG BITS --------------- */
N#define CPU_REG_NVIC_SCR_SEVONPEND 0x00000010
N#define CPU_REG_NVIC_SCR_SLEEPDEEP 0x00000004
N#define CPU_REG_NVIC_SCR_SLEEPONEXIT 0x00000002
N
N /* ----------------- CFG CTRL REG BITS ---------------- */
N#define CPU_REG_NVIC_CCR_STKALIGN 0x00000200
N#define CPU_REG_NVIC_CCR_BFHFNMIGN 0x00000100
N#define CPU_REG_NVIC_CCR_DIV_0_TRP 0x00000010
N#define CPU_REG_NVIC_CCR_UNALIGN_TRP 0x00000008
N#define CPU_REG_NVIC_CCR_USERSETMPEND 0x00000002
N#define CPU_REG_NVIC_CCR_NONBASETHRDENA 0x00000001
N
N /* ------- SYSTEM HANDLER CTRL & STATE REG BITS ------- */
N#define CPU_REG_NVIC_SHCSR_USGFAULTENA 0x00040000
N#define CPU_REG_NVIC_SHCSR_BUSFAULTENA 0x00020000
N#define CPU_REG_NVIC_SHCSR_MEMFAULTENA 0x00010000
N#define CPU_REG_NVIC_SHCSR_SVCALLPENDED 0x00008000
N#define CPU_REG_NVIC_SHCSR_BUSFAULTPENDED 0x00004000
N#define CPU_REG_NVIC_SHCSR_MEMFAULTPENDED 0x00002000
N#define CPU_REG_NVIC_SHCSR_USGFAULTPENDED 0x00001000
N#define CPU_REG_NVIC_SHCSR_SYSTICKACT 0x00000800
N#define CPU_REG_NVIC_SHCSR_PENDSVACT 0x00000400
N#define CPU_REG_NVIC_SHCSR_MONITORACT 0x00000100
N#define CPU_REG_NVIC_SHCSR_SVCALLACT 0x00000080
N#define CPU_REG_NVIC_SHCSR_USGFAULTACT 0x00000008
N#define CPU_REG_NVIC_SHCSR_BUSFAULTACT 0x00000002
N#define CPU_REG_NVIC_SHCSR_MEMFAULTACT 0x00000001
N
N /* -------- CONFIGURABLE FAULT STATUS REG BITS -------- */
N#define CPU_REG_NVIC_CFSR_DIVBYZERO 0x02000000
N#define CPU_REG_NVIC_CFSR_UNALIGNED 0x01000000
N#define CPU_REG_NVIC_CFSR_NOCP 0x00080000
N#define CPU_REG_NVIC_CFSR_INVPC 0x00040000
N#define CPU_REG_NVIC_CFSR_INVSTATE 0x00020000
N#define CPU_REG_NVIC_CFSR_UNDEFINSTR 0x00010000
N#define CPU_REG_NVIC_CFSR_BFARVALID 0x00008000
N#define CPU_REG_NVIC_CFSR_STKERR 0x00001000
N#define CPU_REG_NVIC_CFSR_UNSTKERR 0x00000800
N#define CPU_REG_NVIC_CFSR_IMPRECISERR 0x00000400
N#define CPU_REG_NVIC_CFSR_PRECISERR 0x00000200
N#define CPU_REG_NVIC_CFSR_IBUSERR 0x00000100
N#define CPU_REG_NVIC_CFSR_MMARVALID 0x00000080
N#define CPU_REG_NVIC_CFSR_MSTKERR 0x00000010
N#define CPU_REG_NVIC_CFSR_MUNSTKERR 0x00000008
N#define CPU_REG_NVIC_CFSR_DACCVIOL 0x00000002
N#define CPU_REG_NVIC_CFSR_IACCVIOL 0x00000001
N
N /* ------------ HARD FAULT STATUS REG BITS ------------ */
N#define CPU_REG_NVIC_HFSR_DEBUGEVT 0x80000000
N#define CPU_REG_NVIC_HFSR_FORCED 0x40000000
N#define CPU_REG_NVIC_HFSR_VECTTBL 0x00000002
N
N /* ------------ DEBUG FAULT STATUS REG BITS ----------- */
N#define CPU_REG_NVIC_DFSR_EXTERNAL 0x00000010
N#define CPU_REG_NVIC_DFSR_VCATCH 0x00000008
N#define CPU_REG_NVIC_DFSR_DWTTRAP 0x00000004
N#define CPU_REG_NVIC_DFSR_BKPT 0x00000002
N#define CPU_REG_NVIC_DFSR_HALTED 0x00000001
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CPU REGISTER MASK
N*********************************************************************************************************
N*/
N
N#define CPU_MSK_NVIC_ICSR_VECT_ACTIVE 0x000001FF
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CONFIGURATION ERRORS
N*********************************************************************************************************
N*/
N
N#ifndef CPU_CFG_ADDR_SIZE
S#error "CPU_CFG_ADDR_SIZE not #define'd in 'cpu.h' "
S#error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]"
S#error " [ || CPU_WORD_SIZE_16 16-bit alignment]"
S#error " [ || CPU_WORD_SIZE_32 32-bit alignment]"
S#error " [ || CPU_WORD_SIZE_64 64-bit alignment]"
S
S#elif ((CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_08) && \
S (CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_16) && \
S (CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_32) && \
S (CPU_CFG_ADDR_SIZE != CPU_WORD_SIZE_64))
X#elif ((4 != 1) && (4 != 2) && (4 != 4) && (4 != 8))
S#error "CPU_CFG_ADDR_SIZE illegally #define'd in 'cpu.h' "
S#error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]"
S#error " [ || CPU_WORD_SIZE_16 16-bit alignment]"
S#error " [ || CPU_WORD_SIZE_32 32-bit alignment]"
S#error " [ || CPU_WORD_SIZE_64 64-bit alignment]"
N#endif
N
N
N#ifndef CPU_CFG_DATA_SIZE
S#error "CPU_CFG_DATA_SIZE not #define'd in 'cpu.h' "
S#error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]"
S#error " [ || CPU_WORD_SIZE_16 16-bit alignment]"
S#error " [ || CPU_WORD_SIZE_32 32-bit alignment]"
S#error " [ || CPU_WORD_SIZE_64 64-bit alignment]"
S
S#elif ((CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_08) && \
S (CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_16) && \
S (CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_32) && \
S (CPU_CFG_DATA_SIZE != CPU_WORD_SIZE_64))
X#elif ((4 != 1) && (4 != 2) && (4 != 4) && (4 != 8))
S#error "CPU_CFG_DATA_SIZE illegally #define'd in 'cpu.h' "
S#error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]"
S#error " [ || CPU_WORD_SIZE_16 16-bit alignment]"
S#error " [ || CPU_WORD_SIZE_32 32-bit alignment]"
S#error " [ || CPU_WORD_SIZE_64 64-bit alignment]"
N#endif
N
N
N#ifndef CPU_CFG_DATA_SIZE_MAX
S#error "CPU_CFG_DATA_SIZE_MAX not #define'd in 'cpu.h' "
S#error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]"
S#error " [ || CPU_WORD_SIZE_16 16-bit alignment]"
S#error " [ || CPU_WORD_SIZE_32 32-bit alignment]"
S#error " [ || CPU_WORD_SIZE_64 64-bit alignment]"
S
S#elif ((CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_08) && \
S (CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_16) && \
S (CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_32) && \
S (CPU_CFG_DATA_SIZE_MAX != CPU_WORD_SIZE_64))
X#elif ((8 != 1) && (8 != 2) && (8 != 4) && (8 != 8))
S#error "CPU_CFG_DATA_SIZE_MAX illegally #define'd in 'cpu.h' "
S#error " [MUST be CPU_WORD_SIZE_08 8-bit alignment]"
S#error " [ || CPU_WORD_SIZE_16 16-bit alignment]"
S#error " [ || CPU_WORD_SIZE_32 32-bit alignment]"
S#error " [ || CPU_WORD_SIZE_64 64-bit alignment]"
N#endif
N
N
N
N#if (CPU_CFG_DATA_SIZE_MAX < CPU_CFG_DATA_SIZE)
X#if (8 < 4)
S#error "CPU_CFG_DATA_SIZE_MAX illegally #define'd in 'cpu.h' "
S#error " [MUST be >= CPU_CFG_DATA_SIZE]"
N#endif
N
N
N
N
N/*$PAGE*/
N#ifndef CPU_CFG_ENDIAN_TYPE
S#error "CPU_CFG_ENDIAN_TYPE not #define'd in 'cpu.h' "
S#error " [MUST be CPU_ENDIAN_TYPE_BIG ]"
S#error " [ || CPU_ENDIAN_TYPE_LITTLE]"
S
S#elif ((CPU_CFG_ENDIAN_TYPE != CPU_ENDIAN_TYPE_BIG ) && \
S (CPU_CFG_ENDIAN_TYPE != CPU_ENDIAN_TYPE_LITTLE))
X#elif ((2u != 1u ) && (2u != 2u))
S#error "CPU_CFG_ENDIAN_TYPE illegally #define'd in 'cpu.h' "
S#error " [MUST be CPU_ENDIAN_TYPE_BIG ]"
S#error " [ || CPU_ENDIAN_TYPE_LITTLE]"
N#endif
N
N
N
N
N#ifndef CPU_CFG_STK_GROWTH
S#error "CPU_CFG_STK_GROWTH not #define'd in 'cpu.h' "
S#error " [MUST be CPU_STK_GROWTH_LO_TO_HI]"
S#error " [ || CPU_STK_GROWTH_HI_TO_LO]"
S
S#elif ((CPU_CFG_STK_GROWTH != CPU_STK_GROWTH_LO_TO_HI) && \
S (CPU_CFG_STK_GROWTH != CPU_STK_GROWTH_HI_TO_LO))
X#elif ((2u != 1u) && (2u != 2u))
S#error "CPU_CFG_STK_GROWTH illegally #define'd in 'cpu.h' "
S#error " [MUST be CPU_STK_GROWTH_LO_TO_HI]"
S#error " [ || CPU_STK_GROWTH_HI_TO_LO]"
N#endif
N
N
N
N
N#ifndef CPU_CFG_CRITICAL_METHOD
S#error "CPU_CFG_CRITICAL_METHOD not #define'd in 'cpu.h' "
S#error " [MUST be CPU_CRITICAL_METHOD_INT_DIS_EN ]"
S#error " [ || CPU_CRITICAL_METHOD_STATUS_STK ]"
S#error " [ || CPU_CRITICAL_METHOD_STATUS_LOCAL]"
S
S#elif ((CPU_CFG_CRITICAL_METHOD != CPU_CRITICAL_METHOD_INT_DIS_EN ) && \
S (CPU_CFG_CRITICAL_METHOD != CPU_CRITICAL_METHOD_STATUS_STK ) && \
S (CPU_CFG_CRITICAL_METHOD != CPU_CRITICAL_METHOD_STATUS_LOCAL))
X#elif ((3u != 1u ) && (3u != 2u ) && (3u != 3u))
S#error "CPU_CFG_CRITICAL_METHOD illegally #define'd in 'cpu.h' "
S#error " [MUST be CPU_CRITICAL_METHOD_INT_DIS_EN ]"
S#error " [ || CPU_CRITICAL_METHOD_STATUS_STK ]"
S#error " [ || CPU_CRITICAL_METHOD_STATUS_LOCAL]"
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* MODULE END
N*
N* Note(s) : (1) See 'cpu.h MODULE'.
N*********************************************************************************************************
N*/
N
N#endif /* End of CPU module include. */
N
L 156 "..\..\uCOS-III\uC-LIB\lib_str.h" 2
N
N#include <lib_def.h>
L 1 "..\..\uCOS-III\uC-LIB\lib_def.h" 1
N/*
N*********************************************************************************************************
N* uC/LIB
N* CUSTOM LIBRARY MODULES
N*
N* (c) Copyright 2004-2012; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/LIB is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* CORE CUSTOM LIBRARY MODULE
N*
N* Filename : lib_def.h
N* Version : V1.37.01
N* Programmer(s) : ITJ
N* FBJ
N*********************************************************************************************************
N* Note(s) : (1) Assumes the following versions (or more recent) of software modules are included in
N* the project build :
N*
N* (a) uC/CPU V1.29.00
N*
N*
N* (2) NO compiler-supplied standard library functions are used in library or product software.
N*
N* (a) ALL standard library functions are implemented in the custom library modules :
N*
N* (1) \<Custom Library Directory>\lib_*.*
N*
N* (2) \<Custom Library Directory>\Ports\<cpu>\<compiler>\lib*_a.*
N*
N* where
N* <Custom Library Directory> directory path for custom library software
N* <cpu> directory name for specific processor (CPU)
N* <compiler> directory name for specific compiler
N*
N* (b) Product-specific library functions are implemented in individual products.
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE
N*
N* Note(s) : (1) This library definition header file is protected from multiple pre-processor inclusion
N* through use of the library definition module present pre-processor macro definition.
N*********************************************************************************************************
N*/
N
N#ifndef LIB_DEF_MODULE_PRESENT
N#define LIB_DEF_MODULE_PRESENT
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CUSTOM LIBRARY MODULE VERSION NUMBER
N*
N* Note(s) : (1) (a) The custom library module software version is denoted as follows :
N*
N* Vx.yy.zz
N*
N* where
N* V denotes 'Version' label
N* x denotes major software version revision number
N* yy denotes minor software version revision number
N* zz denotes sub-minor software version revision number
N*
N* (b) The software version label #define is formatted as follows :
N*
N* ver = x.yyzz * 100 * 100
N*
N* where
N* ver denotes software version number scaled as an integer value
N* x.yyzz denotes software version number, where the unscaled integer
N* portion denotes the major version number & the unscaled
N* fractional portion denotes the (concatenated) minor
N* version numbers
N*********************************************************************************************************
N*/
N
N#define LIB_VERSION 13700u /* See Note #1. */
N
N
N/*
N*********************************************************************************************************
N* INCLUDE FILES
N*
N* Note(s) : (1) The custom library software files are located in the following directories :
N*
N* (a) \<Custom Library Directory>\lib_*.*
N*
N* where
N* <Custom Library Directory> directory path for custom library software
N*
N* (2) CPU-configuration software files are located in the following directories :
N*
N* (a) \<CPU-Compiler Directory>\cpu_*.*
N* (b) \<CPU-Compiler Directory>\<cpu>\<compiler>\cpu*.*
N*
N* where
N* <CPU-Compiler Directory> directory path for common CPU-compiler software
N* <cpu> directory name for specific processor (CPU)
N* <compiler> directory name for specific compiler
N*
N* (3) Compiler MUST be configured to include as additional include path directories :
N*
N* (a) '\<Custom Library Directory>\' directory See Note #1a
N*
N* (b) (1) '\<CPU-Compiler Directory>\' directory See Note #2a
N* (2) '\<CPU-Compiler Directory>\<cpu>\<compiler>\' directory See Note #2b
N*********************************************************************************************************
N*/
N
N#include <cpu_def.h>
N#include <cpu.h>
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* STANDARD DEFINES
N*********************************************************************************************************
N*/
N
N#define DEF_NULL ((void *)0)
N
N
N /* ----------------- BOOLEAN DEFINES ------------------ */
N#define DEF_FALSE 0u
N#define DEF_TRUE 1u
N
N#define DEF_NO 0u
N#define DEF_YES 1u
N
N#define DEF_DISABLED 0u
N#define DEF_ENABLED 1u
N
N#define DEF_INACTIVE 0u
N#define DEF_ACTIVE 1u
N
N#define DEF_INVALID 0u
N#define DEF_VALID 1u
N
N#define DEF_OFF 0u
N#define DEF_ON 1u
N
N#define DEF_CLR 0u
N#define DEF_SET 1u
N
N#define DEF_FAIL 0u
N#define DEF_OK 1u
N
N
N /* ------------------- BIT DEFINES -------------------- */
N#define DEF_BIT_NONE 0x00u
N
N#define DEF_BIT_00 0x01u
N#define DEF_BIT_01 0x02u
N#define DEF_BIT_02 0x04u
N#define DEF_BIT_03 0x08u
N#define DEF_BIT_04 0x10u
N#define DEF_BIT_05 0x20u
N#define DEF_BIT_06 0x40u
N#define DEF_BIT_07 0x80u
N
N#define DEF_BIT_08 0x0100u
N#define DEF_BIT_09 0x0200u
N#define DEF_BIT_10 0x0400u
N#define DEF_BIT_11 0x0800u
N#define DEF_BIT_12 0x1000u
N#define DEF_BIT_13 0x2000u
N#define DEF_BIT_14 0x4000u
N#define DEF_BIT_15 0x8000u
N
N#define DEF_BIT_16 0x00010000u
N#define DEF_BIT_17 0x00020000u
N#define DEF_BIT_18 0x00040000u
N#define DEF_BIT_19 0x00080000u
N#define DEF_BIT_20 0x00100000u
N#define DEF_BIT_21 0x00200000u
N#define DEF_BIT_22 0x00400000u
N#define DEF_BIT_23 0x00800000u
N
N#define DEF_BIT_24 0x01000000u
N#define DEF_BIT_25 0x02000000u
N#define DEF_BIT_26 0x04000000u
N#define DEF_BIT_27 0x08000000u
N#define DEF_BIT_28 0x10000000u
N#define DEF_BIT_29 0x20000000u
N#define DEF_BIT_30 0x40000000u
N#define DEF_BIT_31 0x80000000u
N/*$PAGE*/
N#define DEF_BIT_32 0x0000000100000000u
N#define DEF_BIT_33 0x0000000200000000u
N#define DEF_BIT_34 0x0000000400000000u
N#define DEF_BIT_35 0x0000000800000000u
N#define DEF_BIT_36 0x0000001000000000u
N#define DEF_BIT_37 0x0000002000000000u
N#define DEF_BIT_38 0x0000004000000000u
N#define DEF_BIT_39 0x0000008000000000u
N
N#define DEF_BIT_40 0x0000010000000000u
N#define DEF_BIT_41 0x0000020000000000u
N#define DEF_BIT_42 0x0000040000000000u
N#define DEF_BIT_43 0x0000080000000000u
N#define DEF_BIT_44 0x0000100000000000u
N#define DEF_BIT_45 0x0000200000000000u
N#define DEF_BIT_46 0x0000400000000000u
N#define DEF_BIT_47 0x0000800000000000u
N
N#define DEF_BIT_48 0x0001000000000000u
N#define DEF_BIT_49 0x0002000000000000u
N#define DEF_BIT_50 0x0004000000000000u
N#define DEF_BIT_51 0x0008000000000000u
N#define DEF_BIT_52 0x0010000000000000u
N#define DEF_BIT_53 0x0020000000000000u
N#define DEF_BIT_54 0x0040000000000000u
N#define DEF_BIT_55 0x0080000000000000u
N
N#define DEF_BIT_56 0x0100000000000000u
N#define DEF_BIT_57 0x0200000000000000u
N#define DEF_BIT_58 0x0400000000000000u
N#define DEF_BIT_59 0x0800000000000000u
N#define DEF_BIT_60 0x1000000000000000u
N#define DEF_BIT_61 0x2000000000000000u
N#define DEF_BIT_62 0x4000000000000000u
N#define DEF_BIT_63 0x8000000000000000u
N
N
N /* ------------------ ALIGN DEFINES ------------------- */
N#define DEF_ALIGN_MAX_NBR_OCTETS 4096u
N
N
N /* ------------------ OCTET DEFINES ------------------- */
N#define DEF_OCTET_NBR_BITS 8u
N#define DEF_OCTET_MASK 0xFFu
N
N#define DEF_OCTET_TO_BIT_NBR_BITS 3u
N#define DEF_OCTET_TO_BIT_SHIFT DEF_OCTET_TO_BIT_NBR_BITS
N#define DEF_OCTET_TO_BIT_MASK 0x07u
N
N
N#define DEF_NIBBLE_NBR_BITS 4u
N#define DEF_NIBBLE_MASK 0x0Fu
N
N
N /* --------------- NUMBER BASE DEFINES ---------------- */
N#define DEF_NBR_BASE_BIN 2u
N#define DEF_NBR_BASE_OCT 8u
N#define DEF_NBR_BASE_DEC 10u
N#define DEF_NBR_BASE_HEX 16u
N
N
N/*$PAGE*/
N /* ----------------- INTEGER DEFINES ------------------ */
N#define DEF_INT_08_NBR_BITS 8u
N#define DEF_INT_08_MASK 0xFFu
N
N#define DEF_INT_08U_MIN_VAL 0u
N#define DEF_INT_08U_MAX_VAL 255u
N
N#define DEF_INT_08S_MIN_VAL_ONES_CPL (-127)
N#define DEF_INT_08S_MAX_VAL_ONES_CPL 127
N
N#define DEF_INT_08S_MIN_VAL (DEF_INT_08S_MIN_VAL_ONES_CPL - 1)
N#define DEF_INT_08S_MAX_VAL DEF_INT_08S_MAX_VAL_ONES_CPL
N
N#define DEF_INT_08U_NBR_DIG_MIN 1u
N#define DEF_INT_08U_NBR_DIG_MAX 3u
N
N#define DEF_INT_08S_NBR_DIG_MIN 3u
N#define DEF_INT_08S_NBR_DIG_MAX 3u
N
N
N
N#define DEF_INT_16_NBR_BITS 16u
N#define DEF_INT_16_MASK 0xFFFFu
N
N#define DEF_INT_16U_MIN_VAL 0u
N#define DEF_INT_16U_MAX_VAL 65535u
N
N#define DEF_INT_16S_MIN_VAL_ONES_CPL (-32767)
N#define DEF_INT_16S_MAX_VAL_ONES_CPL 32767
N
N#define DEF_INT_16S_MIN_VAL (DEF_INT_16S_MIN_VAL_ONES_CPL - 1)
N#define DEF_INT_16S_MAX_VAL DEF_INT_16S_MAX_VAL_ONES_CPL
N
N#define DEF_INT_16U_NBR_DIG_MIN 1u
N#define DEF_INT_16U_NBR_DIG_MAX 5u
N
N#define DEF_INT_16S_NBR_DIG_MIN 5u
N#define DEF_INT_16S_NBR_DIG_MAX 5u
N
N
N
N#define DEF_INT_32_NBR_BITS 32u
N#define DEF_INT_32_MASK 0xFFFFFFFFu
N
N#define DEF_INT_32U_MIN_VAL 0u
N#define DEF_INT_32U_MAX_VAL 4294967295u
N
N#define DEF_INT_32S_MIN_VAL_ONES_CPL (-2147483647)
N#define DEF_INT_32S_MAX_VAL_ONES_CPL 2147483647
N
N#define DEF_INT_32S_MIN_VAL (DEF_INT_32S_MIN_VAL_ONES_CPL - 1)
N#define DEF_INT_32S_MAX_VAL DEF_INT_32S_MAX_VAL_ONES_CPL
N
N#define DEF_INT_32U_NBR_DIG_MIN 1u
N#define DEF_INT_32U_NBR_DIG_MAX 10u
N
N#define DEF_INT_32S_NBR_DIG_MIN 10u
N#define DEF_INT_32S_NBR_DIG_MAX 10u
N
N
N
N#define DEF_INT_64_NBR_BITS 64u
N#define DEF_INT_64_MASK 0xFFFFFFFFFFFFFFFFu
N
N#define DEF_INT_64U_MIN_VAL 0u
N#define DEF_INT_64U_MAX_VAL 18446744073709551615u
N
N#define DEF_INT_64S_MIN_VAL_ONES_CPL (-9223372036854775807)
N#define DEF_INT_64S_MAX_VAL_ONES_CPL 9223372036854775807
N
N#define DEF_INT_64S_MIN_VAL (DEF_INT_64S_MIN_VAL_ONES_CPL - 1)
N#define DEF_INT_64S_MAX_VAL DEF_INT_64S_MAX_VAL_ONES_CPL
N
N#define DEF_INT_64U_NBR_DIG_MIN 1u
N#define DEF_INT_64U_NBR_DIG_MAX 20u
N
N#define DEF_INT_64S_NBR_DIG_MIN 19u
N#define DEF_INT_64S_NBR_DIG_MAX 19u
N
N
N
N/*$PAGE*/
N /* --------------- CPU INTEGER DEFINES ---------------- */
N#define DEF_INT_CPU_NBR_BITS (CPU_CFG_DATA_SIZE * DEF_OCTET_NBR_BITS)
N#define DEF_INT_CPU_NBR_BITS_MAX (CPU_CFG_DATA_SIZE_MAX * DEF_OCTET_NBR_BITS)
N
N
N
N#if (DEF_INT_CPU_NBR_BITS == DEF_INT_08_NBR_BITS)
X#if ((4 * 8u) == 8u)
S
S
S#define DEF_INT_CPU_MASK DEF_INT_08_MASK
S
S#define DEF_INT_CPU_U_MIN_VAL DEF_INT_08U_MIN_VAL
S#define DEF_INT_CPU_U_MAX_VAL DEF_INT_08U_MAX_VAL
S
S#define DEF_INT_CPU_S_MIN_VAL DEF_INT_08S_MIN_VAL
S#define DEF_INT_CPU_S_MAX_VAL DEF_INT_08S_MAX_VAL
S
S#define DEF_INT_CPU_S_MIN_VAL_ONES_CPL DEF_INT_08S_MIN_VAL_ONES_CPL
S#define DEF_INT_CPU_S_MAX_VAL_ONES_CPL DEF_INT_08S_MAX_VAL_ONES_CPL
S
S
S
S#elif (DEF_INT_CPU_NBR_BITS == DEF_INT_16_NBR_BITS)
X#elif ((4 * 8u) == 16u)
S
S
S#define DEF_INT_CPU_MASK DEF_INT_16_MASK
S
S#define DEF_INT_CPU_U_MIN_VAL DEF_INT_16U_MIN_VAL
S#define DEF_INT_CPU_U_MAX_VAL DEF_INT_16U_MAX_VAL
S
S#define DEF_INT_CPU_S_MIN_VAL DEF_INT_16S_MIN_VAL
S#define DEF_INT_CPU_S_MAX_VAL DEF_INT_16S_MAX_VAL
S
S#define DEF_INT_CPU_S_MIN_VAL_ONES_CPL DEF_INT_16S_MIN_VAL_ONES_CPL
S#define DEF_INT_CPU_S_MAX_VAL_ONES_CPL DEF_INT_16S_MAX_VAL_ONES_CPL
S
S
S
N#elif (DEF_INT_CPU_NBR_BITS == DEF_INT_32_NBR_BITS)
X#elif ((4 * 8u) == 32u)
N
N
N#define DEF_INT_CPU_MASK DEF_INT_32_MASK
N
N#define DEF_INT_CPU_U_MIN_VAL DEF_INT_32U_MIN_VAL
N#define DEF_INT_CPU_U_MAX_VAL DEF_INT_32U_MAX_VAL
N
N#define DEF_INT_CPU_S_MIN_VAL DEF_INT_32S_MIN_VAL
N#define DEF_INT_CPU_S_MAX_VAL DEF_INT_32S_MAX_VAL
N
N#define DEF_INT_CPU_S_MIN_VAL_ONES_CPL DEF_INT_32S_MIN_VAL_ONES_CPL
N#define DEF_INT_CPU_S_MAX_VAL_ONES_CPL DEF_INT_32S_MAX_VAL_ONES_CPL
N
N
N
N#elif (DEF_INT_CPU_NBR_BITS == DEF_INT_64_NBR_BITS)
S
S
S#define DEF_INT_CPU_MASK DEF_INT_64_MASK
S
S#define DEF_INT_CPU_U_MIN_VAL DEF_INT_64U_MIN_VAL
S#define DEF_INT_CPU_U_MAX_VAL DEF_INT_64U_MAX_VAL
S
S#define DEF_INT_CPU_S_MIN_VAL DEF_INT_64S_MIN_VAL
S#define DEF_INT_CPU_S_MAX_VAL DEF_INT_64S_MAX_VAL
S
S#define DEF_INT_CPU_S_MIN_VAL_ONES_CPL DEF_INT_64S_MIN_VAL_ONES_CPL
S#define DEF_INT_CPU_S_MAX_VAL_ONES_CPL DEF_INT_64S_MAX_VAL_ONES_CPL
S
S
S
S#else
S
S#error "CPU_CFG_DATA_SIZE illegally #defined in 'cpu.h' "
S#error " [See 'cpu.h CONFIGURATION ERRORS']"
S
N#endif
N
N
N
N/*$PAGE*/
N /* ------------------- TIME DEFINES ------------------- */
N#define DEF_TIME_NBR_DAY_PER_WK 7u
N#define DEF_TIME_NBR_DAY_PER_YR 365u
N#define DEF_TIME_NBR_DAY_PER_YR_LEAP 366u
N
N#define DEF_TIME_NBR_HR_PER_DAY 24u
N#define DEF_TIME_NBR_HR_PER_WK (DEF_TIME_NBR_HR_PER_DAY * DEF_TIME_NBR_DAY_PER_WK )
N#define DEF_TIME_NBR_HR_PER_YR (DEF_TIME_NBR_HR_PER_DAY * DEF_TIME_NBR_DAY_PER_YR )
N#define DEF_TIME_NBR_HR_PER_YR_LEAP (DEF_TIME_NBR_HR_PER_DAY * DEF_TIME_NBR_DAY_PER_YR_LEAP)
N
N#define DEF_TIME_NBR_MIN_PER_HR 60u
N#define DEF_TIME_NBR_MIN_PER_DAY (DEF_TIME_NBR_MIN_PER_HR * DEF_TIME_NBR_HR_PER_DAY )
N#define DEF_TIME_NBR_MIN_PER_WK (DEF_TIME_NBR_MIN_PER_DAY * DEF_TIME_NBR_DAY_PER_WK )
N#define DEF_TIME_NBR_MIN_PER_YR (DEF_TIME_NBR_MIN_PER_DAY * DEF_TIME_NBR_DAY_PER_YR )
N#define DEF_TIME_NBR_MIN_PER_YR_LEAP (DEF_TIME_NBR_MIN_PER_DAY * DEF_TIME_NBR_DAY_PER_YR_LEAP)
N
N#define DEF_TIME_NBR_SEC_PER_MIN 60u
N#define DEF_TIME_NBR_SEC_PER_HR (DEF_TIME_NBR_SEC_PER_MIN * DEF_TIME_NBR_MIN_PER_HR )
N#define DEF_TIME_NBR_SEC_PER_DAY (DEF_TIME_NBR_SEC_PER_HR * DEF_TIME_NBR_HR_PER_DAY )
N#define DEF_TIME_NBR_SEC_PER_WK (DEF_TIME_NBR_SEC_PER_DAY * DEF_TIME_NBR_DAY_PER_WK )
N#define DEF_TIME_NBR_SEC_PER_YR (DEF_TIME_NBR_SEC_PER_DAY * DEF_TIME_NBR_DAY_PER_YR )
N#define DEF_TIME_NBR_SEC_PER_YR_LEAP (DEF_TIME_NBR_SEC_PER_DAY * DEF_TIME_NBR_DAY_PER_YR_LEAP)
N
N#define DEF_TIME_NBR_mS_PER_SEC 1000u
N#define DEF_TIME_NBR_uS_PER_SEC 1000000u
N#define DEF_TIME_NBR_nS_PER_SEC 1000000000u
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ERROR CODES
N*
N* Note(s) : (1) All library error codes are #define'd in 'lib_def.h';
N*********************************************************************************************************
N*/
N
Ntypedef enum lib_err {
N
N LIB_ERR_NONE = 0u,
N
N LIB_MEM_ERR_NONE = 10000u,
N LIB_MEM_ERR_NULL_PTR = 10001u, /* Ptr arg(s) passed NULL ptr(s). */
N
N LIB_MEM_ERR_INVALID_MEM_SIZE = 10100u, /* Invalid mem size. */
N LIB_MEM_ERR_INVALID_MEM_ALIGN = 10101u, /* Invalid mem align. */
N LIB_MEM_ERR_INVALID_SEG_SIZE = 10110u, /* Invalid mem seg size. */
N LIB_MEM_ERR_INVALID_SEG_OVERLAP = 10111u, /* Invalid mem seg overlaps other mem seg(s). */
N LIB_MEM_ERR_INVALID_POOL = 10120u, /* Invalid mem pool. */
N LIB_MEM_ERR_INVALID_BLK_NBR = 10130u, /* Invalid mem pool blk nbr. */
N LIB_MEM_ERR_INVALID_BLK_SIZE = 10131u, /* Invalid mem pool blk size. */
N LIB_MEM_ERR_INVALID_BLK_ALIGN = 10132u, /* Invalid mem pool blk align. */
N LIB_MEM_ERR_INVALID_BLK_IX = 10133u, /* Invalid mem pool ix. */
N LIB_MEM_ERR_INVALID_BLK_ADDR = 10135u, /* Invalid mem pool blk addr. */
N LIB_MEM_ERR_INVALID_BLK_ADDR_IN_POOL = 10136u, /* Mem pool blk addr already in mem pool. */
N
N LIB_MEM_ERR_SEG_EMPTY = 10200u, /* Mem seg empty; i.e. NO avail mem in seg. */
N LIB_MEM_ERR_SEG_OVF = 10201u, /* Mem seg ovf; i.e. req'd mem ovfs rem mem in seg. */
N LIB_MEM_ERR_POOL_FULL = 10205u, /* Mem pool full; i.e. all mem blks avail in mem pool. */
N LIB_MEM_ERR_POOL_EMPTY = 10206u, /* Mem pool empty; i.e. NO mem blks avail in mem pool. */
N
N LIB_MEM_ERR_HEAP_EMPTY = 10210u, /* Heap seg empty; i.e. NO avail mem in heap. */
N LIB_MEM_ERR_HEAP_OVF = 10211u, /* Heap seg ovf; i.e. req'd mem ovfs rem mem in heap. */
N LIB_MEM_ERR_HEAP_NOT_FOUND = 10215u /* Heap seg NOT found. */
N
N} LIB_ERR;
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DATA TYPES
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* GLOBAL VARIABLES
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* TRACING
N*********************************************************************************************************
N*/
N
N /* Trace level, default to TRACE_LEVEL_OFF. */
N#ifndef TRACE_LEVEL_OFF
N#define TRACE_LEVEL_OFF 0u
N#endif
N
N#ifndef TRACE_LEVEL_INFO
N#define TRACE_LEVEL_INFO 1u
N#endif
N
N#ifndef TRACE_LEVEL_DBG
N#define TRACE_LEVEL_DBG 2u
N#endif
N
N#ifndef TRACE_LEVEL_LOG
N#define TRACE_LEVEL_LOG 3u
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* BIT MACRO'S
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* DEF_BIT()
N*
N* Description : Create bit mask with single, specified bit set.
N*
N* Argument(s) : bit Bit number of bit to set.
N*
N* Return(s) : Bit mask with single, specified bit set.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'bit' SHOULD be a non-negative integer.
N*
N* (2) (a) 'bit' values that overflow the target CPU &/or compiler environment (e.g. negative
N* or greater-than-CPU-data-size values) MAY generate compiler warnings &/or errors.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT(bit) (1u << (bit))
N
N
N/*
N*********************************************************************************************************
N* DEF_BITxx()
N*
N* Description : Create bit mask of specified bit size with single, specified bit set.
N*
N* Argument(s) : bit Bit number of bit to set.
N*
N* Return(s) : Bit mask with single, specified bit set.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'bit' SHOULD be a non-negative integer.
N*
N* (2) (a) 'bit' values that overflow the target CPU &/or compiler environment (e.g. negative
N* or greater-than-CPU-data-size values) MAY generate compiler warnings &/or errors.
N*
N* (b) To avoid overflowing any target CPU &/or compiler's integer data type, unsigned
N* bit constant '1' is cast to specified integer data type size.
N*
N* (3) Ideally, DEF_BITxx() macro's should be named DEF_BIT_xx(); however, these names already
N* previously-released for bit constant #define's (see 'STANDARD DEFINES BIT DEFINES').
N*********************************************************************************************************
N*/
N
N#define DEF_BIT08(bit) ((CPU_INT08U)((CPU_INT08U)1u << (bit)))
N
N#define DEF_BIT16(bit) ((CPU_INT16U)((CPU_INT16U)1u << (bit)))
N
N#define DEF_BIT32(bit) ((CPU_INT32U)((CPU_INT32U)1u << (bit)))
N
N#define DEF_BIT64(bit) ((CPU_INT64U)((CPU_INT64U)1u << (bit)))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_BIT_MASK()
N*
N* Description : Shift a bit mask.
N*
N* Argument(s) : bit_mask Bit mask to shift.
N*
N* bit_shift Number of bit positions to left-shift bit mask.
N*
N* Return(s) : Shifted bit mask.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) 'bit_mask' SHOULD be an unsigned integer.
N*
N* (b) 'bit_shift' SHOULD be a non-negative integer.
N*
N* (2) 'bit_shift' values that overflow the target CPU &/or compiler environment (e.g. negative
N* or greater-than-CPU-data-size values) MAY generate compiler warnings &/or errors.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_MASK(bit_mask, bit_shift) ((bit_mask) << (bit_shift))
N
N
N/*
N*********************************************************************************************************
N* DEF_BIT_MASK_xx()
N*
N* Description : Shift a bit mask of specified bit size.
N*
N* Argument(s) : bit_mask Bit mask to shift.
N*
N* bit_shift Number of bit positions to left-shift bit mask.
N*
N* Return(s) : Shifted bit mask.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) 'bit_mask' SHOULD be an unsigned integer.
N*
N* (b) 'bit_shift' SHOULD be a non-negative integer.
N*
N* (2) 'bit_shift' values that overflow the target CPU &/or compiler environment (e.g. negative
N* or greater-than-CPU-data-size values) MAY generate compiler warnings &/or errors.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_MASK_08(bit_mask, bit_shift) ((CPU_INT08U)((CPU_INT08U)(bit_mask) << (bit_shift)))
N
N#define DEF_BIT_MASK_16(bit_mask, bit_shift) ((CPU_INT16U)((CPU_INT16U)(bit_mask) << (bit_shift)))
N
N#define DEF_BIT_MASK_32(bit_mask, bit_shift) ((CPU_INT32U)((CPU_INT32U)(bit_mask) << (bit_shift)))
N
N#define DEF_BIT_MASK_64(bit_mask, bit_shift) ((CPU_INT64U)((CPU_INT64U)(bit_mask) << (bit_shift)))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_BIT_FIELD()
N*
N* Description : Create & shift a contiguous bit field.
N*
N* Argument(s) : bit_field Number of contiguous bits to set in the bit field.
N*
N* bit_shift Number of bit positions to left-shift bit field.
N*
N* Return(s) : Shifted bit field.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'bit_field' & 'bit_shift' SHOULD be non-negative integers.
N*
N* (2) (a) 'bit_field'/'bit_shift' values that overflow the target CPU &/or compiler
N* environment (e.g. negative or greater-than-CPU-data-size values) MAY generate
N* compiler warnings &/or errors.
N*
N* (b) To avoid overflowing any target CPU &/or compiler's integer data type, unsigned
N* bit constant '1' is suffixed with 'L'ong integer modifier.
N*
N* This may still be insufficient for CPUs &/or compilers that support 'long long'
N* integer data types, in which case 'LL' integer modifier should be suffixed.
N* However, since almost all 16- & 32-bit CPUs & compilers support 'long' integer
N* data types but many may NOT support 'long long' integer data types, only 'long'
N* integer data types & modifiers are supported.
N*
N* See also 'DEF_BIT_FIELD_xx() Note #1b'.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_FIELD(bit_field, bit_shift) ((((bit_field) >= DEF_INT_CPU_NBR_BITS) ? (DEF_INT_CPU_U_MAX_VAL) \
N : (DEF_BIT(bit_field) - 1uL)) \
N << (bit_shift))
X#define DEF_BIT_FIELD(bit_field, bit_shift) ((((bit_field) >= DEF_INT_CPU_NBR_BITS) ? (DEF_INT_CPU_U_MAX_VAL) : (DEF_BIT(bit_field) - 1uL)) << (bit_shift))
N
N/*
N*********************************************************************************************************
N* DEF_BIT_FIELD_xx()
N*
N* Description : Create & shift a contiguous bit field of specified bit size.
N*
N* Argument(s) : bit_field Number of contiguous bits to set in the bit field.
N*
N* bit_shift Number of bit positions to left-shift bit field.
N*
N* Return(s) : Shifted bit field.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'bit_field' & 'bit_shift' SHOULD be non-negative integers.
N*
N* (2) (a) 'bit_field'/'bit_shift' values that overflow the target CPU &/or compiler
N* environment (e.g. negative or greater-than-CPU-data-size values) MAY generate
N* compiler warnings &/or errors.
N*
N* (b) To avoid overflowing any target CPU &/or compiler's integer data type, unsigned
N* bit constant '1' is cast to specified integer data type size.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_FIELD_08(bit_field, bit_shift) ((CPU_INT08U)((((CPU_INT08U)(bit_field) >= (CPU_INT08U)DEF_INT_08_NBR_BITS) ? (CPU_INT08U)(DEF_INT_08U_MAX_VAL) \
N : (CPU_INT08U)(DEF_BIT08(bit_field) - (CPU_INT08U)1u)) \
N << (bit_shift)))
X#define DEF_BIT_FIELD_08(bit_field, bit_shift) ((CPU_INT08U)((((CPU_INT08U)(bit_field) >= (CPU_INT08U)DEF_INT_08_NBR_BITS) ? (CPU_INT08U)(DEF_INT_08U_MAX_VAL) : (CPU_INT08U)(DEF_BIT08(bit_field) - (CPU_INT08U)1u)) << (bit_shift)))
N
N#define DEF_BIT_FIELD_16(bit_field, bit_shift) ((CPU_INT16U)((((CPU_INT16U)(bit_field) >= (CPU_INT16U)DEF_INT_16_NBR_BITS) ? (CPU_INT16U)(DEF_INT_16U_MAX_VAL) \
N : (CPU_INT16U)(DEF_BIT16(bit_field) - (CPU_INT16U)1u)) \
N << (bit_shift)))
X#define DEF_BIT_FIELD_16(bit_field, bit_shift) ((CPU_INT16U)((((CPU_INT16U)(bit_field) >= (CPU_INT16U)DEF_INT_16_NBR_BITS) ? (CPU_INT16U)(DEF_INT_16U_MAX_VAL) : (CPU_INT16U)(DEF_BIT16(bit_field) - (CPU_INT16U)1u)) << (bit_shift)))
N
N#define DEF_BIT_FIELD_32(bit_field, bit_shift) ((CPU_INT32U)((((CPU_INT32U)(bit_field) >= (CPU_INT32U)DEF_INT_32_NBR_BITS) ? (CPU_INT32U)(DEF_INT_32U_MAX_VAL) \
N : (CPU_INT32U)(DEF_BIT32(bit_field) - (CPU_INT32U)1u)) \
N << (bit_shift)))
X#define DEF_BIT_FIELD_32(bit_field, bit_shift) ((CPU_INT32U)((((CPU_INT32U)(bit_field) >= (CPU_INT32U)DEF_INT_32_NBR_BITS) ? (CPU_INT32U)(DEF_INT_32U_MAX_VAL) : (CPU_INT32U)(DEF_BIT32(bit_field) - (CPU_INT32U)1u)) << (bit_shift)))
N
N#define DEF_BIT_FIELD_64(bit_field, bit_shift) ((CPU_INT64U)((((CPU_INT64U)(bit_field) >= (CPU_INT64U)DEF_INT_64_NBR_BITS) ? (CPU_INT64U)(DEF_INT_64U_MAX_VAL) \
N : (CPU_INT64U)(DEF_BIT64(bit_field) - (CPU_INT64U)1u)) \
N << (bit_shift)))
X#define DEF_BIT_FIELD_64(bit_field, bit_shift) ((CPU_INT64U)((((CPU_INT64U)(bit_field) >= (CPU_INT64U)DEF_INT_64_NBR_BITS) ? (CPU_INT64U)(DEF_INT_64U_MAX_VAL) : (CPU_INT64U)(DEF_BIT64(bit_field) - (CPU_INT64U)1u)) << (bit_shift)))
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_BIT_SET_xx()
N*
N* Description : Set specified bit(s) in a value of specified bit size.
N*
N* Argument(s) : val Value to modify by setting specified bit(s).
N*
N* mask Mask of bits to set.
N*
N* Return(s) : Modified value with specified bit(s) set.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_SET_08(val, mask) ((val) = (CPU_INT08U)(((CPU_INT08U)(val)) | ((CPU_INT08U) (mask))))
N
N#define DEF_BIT_SET_16(val, mask) ((val) = (CPU_INT16U)(((CPU_INT16U)(val)) | ((CPU_INT16U) (mask))))
N
N#define DEF_BIT_SET_32(val, mask) ((val) = (CPU_INT32U)(((CPU_INT32U)(val)) | ((CPU_INT32U) (mask))))
N
N#define DEF_BIT_SET_64(val, mask) ((val) = (CPU_INT64U)(((CPU_INT64U)(val)) | ((CPU_INT64U) (mask))))
N
N
N/*
N*********************************************************************************************************
N* DEF_BIT_SET()
N*
N* Description : Set specified bit(s) in a value.
N*
N* Argument(s) : val Value to modify by setting specified bit(s).
N*
N* mask Mask of bits to set.
N*
N* Return(s) : Modified value with specified bit(s) set.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*********************************************************************************************************
N*/
N
N#if (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_08)
X#if (8 == 1)
S
S#define DEF_BIT_SET(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_SET_08(val, mask) : 0)
S
S
S#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_16)
X#elif (8 == 2)
S
S#define DEF_BIT_SET(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_SET_08(val, mask) : \
S ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_SET_16(val, mask) : 0))
X#define DEF_BIT_SET(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_SET_08(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_SET_16(val, mask) : 0))
S
S
S#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_32)
X#elif (8 == 4)
S
S#define DEF_BIT_SET(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_SET_08(val, mask) : \
S ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_SET_16(val, mask) : \
S ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_SET_32(val, mask) : 0)))
X#define DEF_BIT_SET(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_SET_08(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_SET_16(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_SET_32(val, mask) : 0)))
S
S
N#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_64)
X#elif (8 == 8)
N
N#define DEF_BIT_SET(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_SET_08(val, mask) : \
N ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_SET_16(val, mask) : \
N ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_SET_32(val, mask) : \
N ((sizeof(val) == CPU_WORD_SIZE_64) ? DEF_BIT_SET_64(val, mask) : 0))))
X#define DEF_BIT_SET(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_SET_08(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_SET_16(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_SET_32(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_64) ? DEF_BIT_SET_64(val, mask) : 0))))
N
N#else
S
S#error "CPU_CFG_DATA_SIZE_MAX illegally #defined in 'cpu.h' "
S#error " [See 'cpu.h CONFIGURATION ERRORS']"
S
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_BIT_CLR_xx()
N*
N* Description : Clear specified bit(s) in a value of specified bit size.
N*
N* Argument(s) : val Value to modify by clearing specified bit(s).
N*
N* mask Mask of bits to clear.
N*
N* Return(s) : Modified value with specified bit(s) clear.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_CLR_08(val, mask) ((val) = (CPU_INT08U)(((CPU_INT08U)(val)) & ((CPU_INT08U)~(mask))))
N
N#define DEF_BIT_CLR_16(val, mask) ((val) = (CPU_INT16U)(((CPU_INT16U)(val)) & ((CPU_INT16U)~(mask))))
N
N#define DEF_BIT_CLR_32(val, mask) ((val) = (CPU_INT32U)(((CPU_INT32U)(val)) & ((CPU_INT32U)~(mask))))
N
N#define DEF_BIT_CLR_64(val, mask) ((val) = (CPU_INT64U)(((CPU_INT64U)(val)) & ((CPU_INT64U)~(mask))))
N
N
N/*
N*********************************************************************************************************
N* DEF_BIT_CLR()
N*
N* Description : Clear specified bit(s) in a value.
N*
N* Argument(s) : val Value to modify by clearing specified bit(s).
N*
N* mask Mask of bits to clear.
N*
N* Return(s) : Modified value with specified bit(s) clear.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*********************************************************************************************************
N*/
N
N#if (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_08)
X#if (8 == 1)
S
S#define DEF_BIT_CLR(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_CLR_08(val, mask) : 0)
S
S
S#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_16)
X#elif (8 == 2)
S
S#define DEF_BIT_CLR(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_CLR_08(val, mask) : \
S ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_CLR_16(val, mask) : 0))
X#define DEF_BIT_CLR(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_CLR_08(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_CLR_16(val, mask) : 0))
S
S
S#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_32)
X#elif (8 == 4)
S
S#define DEF_BIT_CLR(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_CLR_08(val, mask) : \
S ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_CLR_16(val, mask) : \
S ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_CLR_32(val, mask) : 0)))
X#define DEF_BIT_CLR(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_CLR_08(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_CLR_16(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_CLR_32(val, mask) : 0)))
S
S
N#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_64)
X#elif (8 == 8)
N
N#define DEF_BIT_CLR(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_CLR_08(val, mask) : \
N ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_CLR_16(val, mask) : \
N ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_CLR_32(val, mask) : \
N ((sizeof(val) == CPU_WORD_SIZE_64) ? DEF_BIT_CLR_64(val, mask) : 0))))
X#define DEF_BIT_CLR(val, mask) ((sizeof(val) == CPU_WORD_SIZE_08) ? DEF_BIT_CLR_08(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_16) ? DEF_BIT_CLR_16(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_32) ? DEF_BIT_CLR_32(val, mask) : ((sizeof(val) == CPU_WORD_SIZE_64) ? DEF_BIT_CLR_64(val, mask) : 0))))
N
N#else
S
S#error "CPU_CFG_DATA_SIZE_MAX illegally #defined in 'cpu.h' "
S#error " [See 'cpu.h CONFIGURATION ERRORS']"
S
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_BIT_IS_SET()
N*
N* Description : Determine if specified bit(s) in a value are set.
N*
N* Argument(s) : val Value to check for specified bit(s) set.
N*
N* mask Mask of bits to check if set (see Note #2).
N*
N* Return(s) : DEF_YES, if ALL specified bit(s) are set in value.
N*
N* DEF_NO, if ALL specified bit(s) are NOT set in value.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*
N* (2) NULL 'mask' allowed; returns 'DEF_NO' since NO mask bits specified.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_IS_SET(val, mask) ((((mask) != 0u) && \
N (((val) & (mask)) == (mask))) ? (DEF_YES) : (DEF_NO ))
X#define DEF_BIT_IS_SET(val, mask) ((((mask) != 0u) && (((val) & (mask)) == (mask))) ? (DEF_YES) : (DEF_NO ))
N
N
N/*
N*********************************************************************************************************
N* DEF_BIT_IS_CLR()
N*
N* Description : Determine if specified bit(s) in a value are clear.
N*
N* Argument(s) : val Value to check for specified bit(s) clear.
N*
N* mask Mask of bits to check if clear (see Note #2).
N*
N* Return(s) : DEF_YES, if ALL specified bit(s) are clear in value.
N*
N* DEF_NO, if ALL specified bit(s) are NOT clear in value.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*
N* (2) NULL 'mask' allowed; returns 'DEF_NO' since NO mask bits specified.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_IS_CLR(val, mask) ((((mask) != 0u) && \
N (((val) & (mask)) == 0u)) ? (DEF_YES) : (DEF_NO ))
X#define DEF_BIT_IS_CLR(val, mask) ((((mask) != 0u) && (((val) & (mask)) == 0u)) ? (DEF_YES) : (DEF_NO ))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_BIT_IS_SET_ANY()
N*
N* Description : Determine if any specified bit(s) in a value are set.
N*
N* Argument(s) : val Value to check for specified bit(s) set.
N*
N* mask Mask of bits to check if set (see Note #2).
N*
N* Return(s) : DEF_YES, if ANY specified bit(s) are set in value.
N*
N* DEF_NO, if ALL specified bit(s) are NOT set in value.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*
N* (2) NULL 'mask' allowed; returns 'DEF_NO' since NO mask bits specified.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_IS_SET_ANY(val, mask) ((((val) & (mask)) == 0u) ? (DEF_NO ) : (DEF_YES))
N
N
N/*
N*********************************************************************************************************
N* DEF_BIT_IS_CLR_ANY()
N*
N* Description : Determine if any specified bit(s) in a value are clear.
N*
N* Argument(s) : val Value to check for specified bit(s) clear.
N*
N* mask Mask of bits to check if clear (see Note #2).
N*
N* Return(s) : DEF_YES, if ANY specified bit(s) are clear in value.
N*
N* DEF_NO, if ALL specified bit(s) are NOT clear in value.
N*
N* Note(s) : (1) 'val' & 'mask' SHOULD be unsigned integers.
N*
N* (2) NULL 'mask' allowed; returns 'DEF_NO' since NO mask bits specified.
N*********************************************************************************************************
N*/
N
N#define DEF_BIT_IS_CLR_ANY(val, mask) ((((val) & (mask)) == (mask)) ? (DEF_NO ) : (DEF_YES))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* VALUE MACRO'S
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* DEF_CHK_VAL_MIN()
N*
N* Description : Validate a value as greater than or equal to a specified minimum value.
N*
N* Argument(s) : val Value to validate.
N*
N* val_min Minimum value to test.
N*
N* Return(s) : DEF_OK, Value is greater than or equal to minimum value.
N*
N* DEF_FAIL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) DEF_CHK_VAL_MIN() avoids directly comparing any two values if only one of the values
N* is negative since the negative value might be incorrectly promoted to an arbitrary
N* unsigned value if the other value to compare is unsigned.
N*
N* (2) Validation of values is limited to the range supported by the compiler &/or target
N* environment. All other values that underflow/overflow the supported range will
N* modulo/wrap into the supported range as arbitrary signed or unsigned values.
N*
N* Therefore, any values that underflow the most negative signed value or overflow
N* the most positive unsigned value supported by the compiler &/or target environment
N* cannot be validated :
N*
N* ( N-1 N ]
N* ( -(2 ) , 2 - 1 ]
N* ( ]
N*
N* where
N* N Number of data word bits supported by the compiler
N* &/or target environment
N*
N* (a) Note that the most negative value, -2^(N-1), is NOT included in the supported
N* range since many compilers do NOT always correctly handle this value.
N*
N* (3) 'val' and 'val_min' are compared to 1 instead of 0 to avoid warning generated for
N* unsigned numbers.
N*********************************************************************************************************
N*/
N
N#define DEF_CHK_VAL_MIN(val, val_min) (((!(((val) >= 1) && ((val_min) < 1))) && \
N ((((val_min) >= 1) && ((val) < 1)) || \
N ((val) < (val_min)))) ? DEF_FAIL : DEF_OK)
X#define DEF_CHK_VAL_MIN(val, val_min) (((!(((val) >= 1) && ((val_min) < 1))) && ((((val_min) >= 1) && ((val) < 1)) || ((val) < (val_min)))) ? DEF_FAIL : DEF_OK)
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_CHK_VAL_MAX()
N*
N* Description : Validate a value as less than or equal to a specified maximum value.
N*
N* Argument(s) : val Value to validate.
N*
N* val_max Maximum value to test.
N*
N* Return(s) : DEF_OK, Value is less than or equal to maximum value.
N*
N* DEF_FAIL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) DEF_CHK_VAL_MAX() avoids directly comparing any two values if only one of the values
N* is negative since the negative value might be incorrectly promoted to an arbitrary
N* unsigned value if the other value to compare is unsigned.
N*
N* (2) Validation of values is limited to the range supported by the compiler &/or target
N* environment. All other values that underflow/overflow the supported range will
N* modulo/wrap into the supported range as arbitrary signed or unsigned values.
N*
N* Therefore, any values that underflow the most negative signed value or overflow
N* the most positive unsigned value supported by the compiler &/or target environment
N* cannot be validated :
N*
N* ( N-1 N ]
N* ( -(2 ) , 2 - 1 ]
N* ( ]
N*
N* where
N* N Number of data word bits supported by the compiler
N* &/or target environment
N*
N* (a) Note that the most negative value, -2^(N-1), is NOT included in the supported
N* range since many compilers do NOT always correctly handle this value.
N*
N* (3) 'val' and 'val_max' are compared to 1 instead of 0 to avoid warning generated for
N* unsigned numbers.
N*********************************************************************************************************
N*/
N
N#define DEF_CHK_VAL_MAX(val, val_max) (((!(((val_max) >= 1) && ((val) < 1))) && \
N ((((val) >= 1) && ((val_max) < 1)) || \
N ((val) > (val_max)))) ? DEF_FAIL : DEF_OK)
X#define DEF_CHK_VAL_MAX(val, val_max) (((!(((val_max) >= 1) && ((val) < 1))) && ((((val) >= 1) && ((val_max) < 1)) || ((val) > (val_max)))) ? DEF_FAIL : DEF_OK)
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_CHK_VAL()
N*
N* Description : Validate a value as greater than or equal to a specified minimum value & less than or
N* equal to a specified maximum value.
N*
N* Argument(s) : val Value to validate.
N*
N* val_min Minimum value to test.
N*
N* val_max Maximum value to test.
N*
N* Return(s) : DEF_OK, Value is greater than or equal to minimum value AND
N* less than or equal to maximum value.
N*
N* DEF_FAIL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) DEF_CHK_VAL() avoids directly comparing any two values if only one of the values
N* is negative since the negative value might be incorrectly promoted to an arbitrary
N* unsigned value if the other value to compare is unsigned.
N*
N* (2) Validation of values is limited to the range supported by the compiler &/or target
N* environment. All other values that underflow/overflow the supported range will
N* modulo/wrap into the supported range as arbitrary signed or unsigned values.
N*
N* Therefore, any values that underflow the most negative signed value or overflow
N* the most positive unsigned value supported by the compiler &/or target environment
N* cannot be validated :
N*
N* ( N-1 N ]
N* ( -(2 ) , 2 - 1 ]
N* ( ]
N*
N* where
N* N Number of data word bits supported by the compiler
N* &/or target environment
N*
N* (a) Note that the most negative value, -2^(N-1), is NOT included in the supported
N* range since many compilers do NOT always correctly handle this value.
N*
N* (3) DEF_CHK_VAL() does NOT validate that the maximum value ('val_max') is greater than
N* or equal to the minimum value ('val_min').
N*********************************************************************************************************
N*/
N
N#define DEF_CHK_VAL(val, val_min, val_max) (((DEF_CHK_VAL_MIN(val, val_min) == DEF_FAIL) || \
N (DEF_CHK_VAL_MAX(val, val_max) == DEF_FAIL)) ? DEF_FAIL : DEF_OK)
X#define DEF_CHK_VAL(val, val_min, val_max) (((DEF_CHK_VAL_MIN(val, val_min) == DEF_FAIL) || (DEF_CHK_VAL_MAX(val, val_max) == DEF_FAIL)) ? DEF_FAIL : DEF_OK)
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_GET_U_MAX_VAL()
N*
N* Description : Get the maximum unsigned value that can be represented in an unsigned integer variable
N* of the same data type size as an object.
N*
N* Argument(s) : obj Object or data type to return maximum unsigned value (see Note #1).
N*
N* Return(s) : Maximum unsigned integer value that can be represented by the object, if NO error(s).
N*
N* 0, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) 'obj' SHOULD be an integer object or data type but COULD also be a character or
N* pointer object or data type.
N*********************************************************************************************************
N*/
N
N#if (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_08)
X#if (8 == 1)
S
S#define DEF_GET_U_MAX_VAL(obj) ((sizeof(obj) == CPU_WORD_SIZE_08) ? DEF_INT_08U_MAX_VAL : 0)
S
S
S#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_16)
X#elif (8 == 2)
S
S#define DEF_GET_U_MAX_VAL(obj) ((sizeof(obj) == CPU_WORD_SIZE_08) ? DEF_INT_08U_MAX_VAL : \
S ((sizeof(obj) == CPU_WORD_SIZE_16) ? DEF_INT_16U_MAX_VAL : 0))
X#define DEF_GET_U_MAX_VAL(obj) ((sizeof(obj) == CPU_WORD_SIZE_08) ? DEF_INT_08U_MAX_VAL : ((sizeof(obj) == CPU_WORD_SIZE_16) ? DEF_INT_16U_MAX_VAL : 0))
S
S
S#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_32)
X#elif (8 == 4)
S
S#define DEF_GET_U_MAX_VAL(obj) ((sizeof(obj) == CPU_WORD_SIZE_08) ? DEF_INT_08U_MAX_VAL : \
S ((sizeof(obj) == CPU_WORD_SIZE_16) ? DEF_INT_16U_MAX_VAL : \
S ((sizeof(obj) == CPU_WORD_SIZE_32) ? DEF_INT_32U_MAX_VAL : 0)))
X#define DEF_GET_U_MAX_VAL(obj) ((sizeof(obj) == CPU_WORD_SIZE_08) ? DEF_INT_08U_MAX_VAL : ((sizeof(obj) == CPU_WORD_SIZE_16) ? DEF_INT_16U_MAX_VAL : ((sizeof(obj) == CPU_WORD_SIZE_32) ? DEF_INT_32U_MAX_VAL : 0)))
S
S
N#elif (CPU_CFG_DATA_SIZE_MAX == CPU_WORD_SIZE_64)
X#elif (8 == 8)
N
N#define DEF_GET_U_MAX_VAL(obj) ((sizeof(obj) == CPU_WORD_SIZE_08) ? DEF_INT_08U_MAX_VAL : \
N ((sizeof(obj) == CPU_WORD_SIZE_16) ? DEF_INT_16U_MAX_VAL : \
N ((sizeof(obj) == CPU_WORD_SIZE_32) ? DEF_INT_32U_MAX_VAL : \
N ((sizeof(obj) == CPU_WORD_SIZE_64) ? DEF_INT_64U_MAX_VAL : 0))))
X#define DEF_GET_U_MAX_VAL(obj) ((sizeof(obj) == CPU_WORD_SIZE_08) ? DEF_INT_08U_MAX_VAL : ((sizeof(obj) == CPU_WORD_SIZE_16) ? DEF_INT_16U_MAX_VAL : ((sizeof(obj) == CPU_WORD_SIZE_32) ? DEF_INT_32U_MAX_VAL : ((sizeof(obj) == CPU_WORD_SIZE_64) ? DEF_INT_64U_MAX_VAL : 0))))
N
N#else
S
S#error "CPU_CFG_DATA_SIZE_MAX illegally #defined in 'cpu.h' "
S#error " [See 'cpu.h CONFIGURATION ERRORS']"
S
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* MATH MACRO'S
N*
N* Note(s) : (1) Ideally, ALL mathematical macro's & functions SHOULD be defined in the custom mathematics
N* library ('lib_math.*'). #### However, to maintain backwards compatibility with previously-
N* released modules, mathematical macro & function definitions should only be moved to the
N* custom mathematics library once all previously-released modules are updated to include the
N* custom mathematics library.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* DEF_MIN()
N*
N* Description : Determine the minimum of two values.
N*
N* Argument(s) : a First value.
N*
N* b Second value.
N*
N* Return(s) : Minimum of the two values.
N*
N* Caller(s) : Application.
N*
N* Note(s) : none.
N*********************************************************************************************************
N*/
N
N#define DEF_MIN(a, b) (((a) < (b)) ? (a) : (b))
N
N
N/*
N*********************************************************************************************************
N* DEF_MAX()
N*
N* Description : Determine the maximum of two values.
N*
N* Argument(s) : a First value.
N*
N* b Second value.
N*
N* Return(s) : Maximum of the two values.
N*
N* Note(s) : none.
N*********************************************************************************************************
N*/
N
N#define DEF_MAX(a, b) (((a) > (b)) ? (a) : (b))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEF_ABS()
N*
N* Description : Determine the absolute value of a value.
N*
N* Argument(s) : a Value to calculate absolute value.
N*
N* Return(s) : Absolute value of the value.
N*
N* Caller(s) : Application.
N*
N* Note(s) : none.
N*********************************************************************************************************
N*/
N
N#define DEF_ABS(a) (((a) < 0) ? (-(a)) : (a))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* FUNCTION PROTOTYPES
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* CONFIGURATION ERRORS
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* LIBRARY CONFIGURATION ERRORS
N*********************************************************************************************************
N*/
N
N /* See 'lib_def.h Note #1a'. */
N#if (CPU_CORE_VERSION < 12900u)
X#if (12901u < 12900u)
S#error "CPU_CORE_VERSION [SHOULD be >= V1.29.00]"
N#endif
N
N
N/*
N*********************************************************************************************************
N* MODULE END
N*
N* Note(s) : (1) See 'lib_def.h MODULE'.
N*********************************************************************************************************
N*/
N
N#endif /* End of lib def module include. */
N
L 158 "..\..\uCOS-III\uC-LIB\lib_str.h" 2
N#include <lib_ascii.h>
L 1 "..\..\uCOS-III\uC-LIB\lib_ascii.h" 1
N/*
N*********************************************************************************************************
N* uC/LIB
N* CUSTOM LIBRARY MODULES
N*
N* (c) Copyright 2004-2012; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/LIB is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* ASCII CHARACTER OPERATIONS
N*
N* Filename : lib_ascii.h
N* Version : V1.37.01
N* Programmer(s) : BAN
N*********************************************************************************************************
N* Note(s) : (1) NO compiler-supplied standard library functions are used in library or product software.
N*
N* (a) ALL standard library functions are implemented in the custom library modules :
N*
N* (1) \<Custom Library Directory>\lib_*.*
N*
N* (2) \<Custom Library Directory>\Ports\<cpu>\<compiler>\lib*_a.*
N*
N* where
N* <Custom Library Directory> directory path for custom library software
N* <cpu> directory name for specific processor (CPU)
N* <compiler> directory name for specific compiler
N*
N* (b) Product-specific library functions are implemented in individual products.
N*
N*
N* (2) (a) ECMA-6 '7-Bit coded Character Set' (6th edition), which corresponds to the
N* 3rd edition of ISO 646, specifies several versions of a 7-bit character set :
N*
N* (1) THE GENERAL VERSION, which allows characters at 0x23 and 0x24 to be given a
N* set alternate form and allows the characters 0x40, 0x5B, 0x5D, 0x60, 0x7B &
N* 0x7D to be assigned a "unique graphic character" or to be declared as unused.
N* All other characters are explicitly specified.
N*
N* (2) THE INTERNATIONAL REFERENCE VERSION, which explicitly specifies all characters
N* in the 7-bit character set.
N*
N* (3) NATIONAL & APPLICATION-ORIENTED VERSIONS, which may be derived from the
N* standard in specified ways.
N*
N* (b) The character set represented in this file reproduces the Internation Reference
N* Version. This is identical to the 7-bit character set which occupies Unicode
N* characters 0x0000 through 0x007F. The character names are taken from v5.0 of the
N* Unicode specification, with certain abbreviations so that the resulting #define
N* names will not violate ANSI C naming restriction :
N*
N* (1) For the Latin capital & lowercase letters, the name components 'LETTER_CAPITAL'
N* & 'LETTER_SMALL' are replaced by 'UPPER' & 'LOWER', respectively.
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE
N*
N* Note(s) : (1) This ASCII library header file is protected from multiple pre-processor inclusion through
N* use of the ASCII library module present pre-processor macro definition.
N*********************************************************************************************************
N*/
N
N#ifndef LIB_ASCII_MODULE_PRESENT /* See Note #1. */
N#define LIB_ASCII_MODULE_PRESENT
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* INCLUDE FILES
N*
N* Note(s) : (1) The custom library software files are located in the following directories :
N*
N* (a) \<Custom Library Directory>\lib_*.*
N*
N* where
N* <Custom Library Directory> directory path for custom library software
N*
N* (2) CPU-configuration software files are located in the following directories :
N*
N* (a) \<CPU-Compiler Directory>\cpu_*.*
N* (b) \<CPU-Compiler Directory>\<cpu>\<compiler>\cpu*.*
N*
N* where
N* <CPU-Compiler Directory> directory path for common CPU-compiler software
N* <cpu> directory name for specific processor (CPU)
N* <compiler> directory name for specific compiler
N*
N* (3) Compiler MUST be configured to include as additional include path directories :
N*
N* (a) '\<Custom Library Directory>\' directory See Note #1a
N*
N* (b) (1) '\<CPU-Compiler Directory>\' directory See Note #2a
N* (2) '\<CPU-Compiler Directory>\<cpu>\<compiler>\' directory See Note #2b
N*
N* (4) NO compiler-supplied standard library functions SHOULD be used.
N*********************************************************************************************************
N*/
N
N#include <cpu.h>
N#include <lib_def.h>
N
N
N/*
N*********************************************************************************************************
N* EXTERNS
N*********************************************************************************************************
N*/
N
N#ifdef LIB_ASCII_MODULE
S#define LIB_ASCII_EXT
N#else
N#define LIB_ASCII_EXT extern
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEFINES
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* ASCII CHARACTER DEFINES
N*********************************************************************************************************
N*/
N
N /* -------------------- C0 CONTROLS ------------------- */
N#define ASCII_CHAR_NULL 0x00 /* '\0' */
N#define ASCII_CHAR_START_OF_HEADING 0x01
N#define ASCII_CHAR_START_OF_TEXT 0x02
N#define ASCII_CHAR_END_OF_TEXT 0x03
N#define ASCII_CHAR_END_OF_TRANSMISSION 0x04
N#define ASCII_CHAR_ENQUIRY 0x05
N#define ASCII_CHAR_ACKNOWLEDGE 0x06
N#define ASCII_CHAR_BELL 0x07 /* '\a' */
N#define ASCII_CHAR_BACKSPACE 0x08 /* '\b' */
N#define ASCII_CHAR_CHARACTER_TABULATION 0x09 /* '\t' */
N#define ASCII_CHAR_LINE_FEED 0x0A /* '\n' */
N#define ASCII_CHAR_LINE_TABULATION 0x0B /* '\v' */
N#define ASCII_CHAR_FORM_FEED 0x0C /* '\f' */
N#define ASCII_CHAR_CARRIAGE_RETURN 0x0D /* '\r' */
N#define ASCII_CHAR_SHIFT_OUT 0x0E
N#define ASCII_CHAR_SHIFT_IN 0x0F
N#define ASCII_CHAR_DATA_LINK_ESCAPE 0x10
N#define ASCII_CHAR_DEVICE_CONTROL_ONE 0x11
N#define ASCII_CHAR_DEVICE_CONTROL_TWO 0x12
N#define ASCII_CHAR_DEVICE_CONTROL_THREE 0x13
N#define ASCII_CHAR_DEVICE_CONTROL_FOUR 0x14
N#define ASCII_CHAR_NEGATIVE_ACKNOWLEDGE 0x15
N#define ASCII_CHAR_SYNCHRONOUS_IDLE 0x16
N#define ASCII_CHAR_END_OF_TRANSMISSION_BLOCK 0x17
N#define ASCII_CHAR_CANCEL 0x18
N#define ASCII_CHAR_END_OF_MEDIUM 0x19
N#define ASCII_CHAR_SUBSITUTE 0x1A
N#define ASCII_CHAR_ESCAPE 0x1B
N#define ASCII_CHAR_INFO_SEPARATOR_FOUR 0x1C
N#define ASCII_CHAR_INFO_SEPARATOR_THREE 0x1D
N#define ASCII_CHAR_INFO_SEPARATOR_TWO 0x1E
N#define ASCII_CHAR_INFO_SEPARATOR_ONE 0x1F
N
N#define ASCII_CHAR_NUL ASCII_CHAR_NULL
N#define ASCII_CHAR_SOH ASCII_CHAR_START_OF_HEADING
N#define ASCII_CHAR_START_HEADING ASCII_CHAR_START_OF_HEADING
N#define ASCII_CHAR_STX ASCII_CHAR_START_OF_TEXT
N#define ASCII_CHAR_START_TEXT ASCII_CHAR_START_OF_TEXT
N#define ASCII_CHAR_ETX ASCII_CHAR_END_OF_TEXT
N#define ASCII_CHAR_END_TEXT ASCII_CHAR_END_OF_TEXT
N#define ASCII_CHAR_EOT ASCII_CHAR_END_OF_TRANSMISSION
N#define ASCII_CHAR_END_TRANSMISSION ASCII_CHAR_END_OF_TRANSMISSION
N#define ASCII_CHAR_ENQ ASCII_CHAR_ENQUIRY
N#define ASCII_CHAR_ACK ASCII_CHAR_ACKNOWLEDGE
N#define ASCII_CHAR_BEL ASCII_CHAR_BELL
N#define ASCII_CHAR_BS ASCII_CHAR_BACKSPACE
N#define ASCII_CHAR_HT ASCII_CHAR_CHARACTER_TABULATION
N#define ASCII_CHAR_TAB ASCII_CHAR_CHARACTER_TABULATION
N#define ASCII_CHAR_LF ASCII_CHAR_LINE_FEED
N#define ASCII_CHAR_VT ASCII_CHAR_LINE_TABULATION
N#define ASCII_CHAR_FF ASCII_CHAR_FORM_FEED
N#define ASCII_CHAR_CR ASCII_CHAR_CARRIAGE_RETURN
N#define ASCII_CHAR_SO ASCII_CHAR_SHIFT_OUT
N#define ASCII_CHAR_SI ASCII_CHAR_SHIFT_IN
N#define ASCII_CHAR_DLE ASCII_CHAR_DATA_LINK_ESCAPE
N#define ASCII_CHAR_DC1 ASCII_CHAR_DEVICE_CONTROL_ONE
N#define ASCII_CHAR_DC2 ASCII_CHAR_DEVICE_CONTROL_TWO
N#define ASCII_CHAR_DC3 ASCII_CHAR_DEVICE_CONTROL_THREE
N#define ASCII_CHAR_DC4 ASCII_CHAR_DEVICE_CONTROL_FOUR
N#define ASCII_CHAR_DEV_CTRL_ONE ASCII_CHAR_DEVICE_CONTROL_ONE
N#define ASCII_CHAR_DEV_CTRL_TWO ASCII_CHAR_DEVICE_CONTROL_TWO
N#define ASCII_CHAR_DEV_CTRL_THREE ASCII_CHAR_DEVICE_CONTROL_THREE
N#define ASCII_CHAR_DEV_CTRL_FOUR ASCII_CHAR_DEVICE_CONTROL_FOUR
N#define ASCII_CHAR_NAK ASCII_CHAR_NEGATIVE_ACKNOWLEDGE
N#define ASCII_CHAR_NEG_ACK ASCII_CHAR_NEGATIVE_ACKNOWLEDGE
N#define ASCII_CHAR_SYN ASCII_CHAR_SYNCHRONOUS_IDLE
N#define ASCII_CHAR_SYNC_IDLE ASCII_CHAR_SYNCHRONOUS_IDLE
N#define ASCII_CHAR_ETB ASCII_CHAR_END_OF_TRANSMISSION_BLOCK
N#define ASCII_CHAR_END_TRANSMISSION_BLK ASCII_CHAR_END_OF_TRANSMISSION_BLOCK
N#define ASCII_CHAR_CAN ASCII_CHAR_CANCEL
N#define ASCII_CHAR_EM ASCII_CHAR_END_OF_MEDIUM
N#define ASCII_CHAR_END_MEDIUM ASCII_CHAR_END_OF_MEDIUM
N#define ASCII_CHAR_SUB ASCII_CHAR_SUBSITUTE
N#define ASCII_CHAR_ESC ASCII_CHAR_ESCAPE
N#define ASCII_CHAR_IS1 ASCII_CHAR_INFO_SEPARATOR_ONE
N#define ASCII_CHAR_IS2 ASCII_CHAR_INFO_SEPARATOR_TWO
N#define ASCII_CHAR_IS3 ASCII_CHAR_INFO_SEPARATOR_THREE
N#define ASCII_CHAR_IS4 ASCII_CHAR_INFO_SEPARATOR_FOUR
N
N
N/*$PAGE*/
N /* ------------ ASCII PUNCTUATION & SYMBOLS ----------- */
N#define ASCII_CHAR_SPACE 0x20 /* ' ' */
N#define ASCII_CHAR_EXCLAMATION_MARK 0x21 /* '!' */
N#define ASCII_CHAR_QUOTATION_MARK 0x22 /* '\"' */
N#define ASCII_CHAR_NUMBER_SIGN 0x23 /* '#' */
N#define ASCII_CHAR_DOLLAR_SIGN 0x24 /* '$' */
N#define ASCII_CHAR_PERCENTAGE_SIGN 0x25 /* '%' */
N#define ASCII_CHAR_AMPERSAND 0x26 /* '&' */
N#define ASCII_CHAR_APOSTROPHE 0x27 /* '\'' */
N#define ASCII_CHAR_LEFT_PARENTHESIS 0x28 /* '(' */
N#define ASCII_CHAR_RIGHT_PARENTHESIS 0x29 /* ')' */
N#define ASCII_CHAR_ASTERISK 0x2A /* '*' */
N#define ASCII_CHAR_PLUS_SIGN 0x2B /* '+' */
N#define ASCII_CHAR_COMMA 0x2C /* ',' */
N#define ASCII_CHAR_HYPHEN_MINUS 0x2D /* '-' */
N#define ASCII_CHAR_FULL_STOP 0x2E /* '.' */
N#define ASCII_CHAR_SOLIDUS 0x2F /* '/' */
N
N#define ASCII_CHAR_PAREN_LEFT ASCII_CHAR_LEFT_PARENTHESIS
N#define ASCII_CHAR_PAREN_RIGHT ASCII_CHAR_RIGHT_PARENTHESIS
N
N
N /* ------------------- ASCII DIGITS ------------------- */
N#define ASCII_CHAR_DIGIT_ZERO 0x30 /* '0' */
N#define ASCII_CHAR_DIGIT_ONE 0x31 /* '1' */
N#define ASCII_CHAR_DIGIT_TWO 0x32 /* '2' */
N#define ASCII_CHAR_DIGIT_THREE 0x33 /* '3' */
N#define ASCII_CHAR_DIGIT_FOUR 0x34 /* '4' */
N#define ASCII_CHAR_DIGIT_FIVE 0x35 /* '5' */
N#define ASCII_CHAR_DIGIT_SIX 0x36 /* '6' */
N#define ASCII_CHAR_DIGIT_SEVEN 0x37 /* '7' */
N#define ASCII_CHAR_DIGIT_EIGHT 0x38 /* '8' */
N#define ASCII_CHAR_DIGIT_NINE 0x39 /* '9' */
N
N#define ASCII_CHAR_DIG_ZERO ASCII_CHAR_DIGIT_ZERO
N#define ASCII_CHAR_DIG_ONE ASCII_CHAR_DIGIT_ONE
N#define ASCII_CHAR_DIG_TWO ASCII_CHAR_DIGIT_TWO
N#define ASCII_CHAR_DIG_THREE ASCII_CHAR_DIGIT_THREE
N#define ASCII_CHAR_DIG_FOUR ASCII_CHAR_DIGIT_FOUR
N#define ASCII_CHAR_DIG_FIVE ASCII_CHAR_DIGIT_FIVE
N#define ASCII_CHAR_DIG_SIX ASCII_CHAR_DIGIT_SIX
N#define ASCII_CHAR_DIG_SEVEN ASCII_CHAR_DIGIT_SEVEN
N#define ASCII_CHAR_DIG_EIGHT ASCII_CHAR_DIGIT_EIGHT
N#define ASCII_CHAR_DIG_NINE ASCII_CHAR_DIGIT_NINE
N
N
N /* ------------ ASCII PUNCTUATION & SYMBOLS ----------- */
N#define ASCII_CHAR_COLON 0x3A /* ':' */
N#define ASCII_CHAR_SEMICOLON 0x3B /* ';' */
N#define ASCII_CHAR_LESS_THAN_SIGN 0x3C /* '<' */
N#define ASCII_CHAR_EQUALS_SIGN 0x3D /* '=' */
N#define ASCII_CHAR_GREATER_THAN_SIGN 0x3E /* '>' */
N#define ASCII_CHAR_QUESTION_MARK 0x3F /* '\?' */
N#define ASCII_CHAR_COMMERCIAL_AT 0x40 /* '@' */
N
N#define ASCII_CHAR_AT_SIGN ASCII_CHAR_COMMERCIAL_AT
N
N
N/*$PAGE*/
N /* ------------- UPPERCASE LATIN ALPHABET ------------- */
N#define ASCII_CHAR_LATIN_UPPER_A 0x41 /* 'A' */
N#define ASCII_CHAR_LATIN_UPPER_B 0x42 /* 'B' */
N#define ASCII_CHAR_LATIN_UPPER_C 0x43 /* 'C' */
N#define ASCII_CHAR_LATIN_UPPER_D 0x44 /* 'D' */
N#define ASCII_CHAR_LATIN_UPPER_E 0x45 /* 'E' */
N#define ASCII_CHAR_LATIN_UPPER_F 0x46 /* 'F' */
N#define ASCII_CHAR_LATIN_UPPER_G 0x47 /* 'G' */
N#define ASCII_CHAR_LATIN_UPPER_H 0x48 /* 'H' */
N#define ASCII_CHAR_LATIN_UPPER_I 0x49 /* 'I' */
N#define ASCII_CHAR_LATIN_UPPER_J 0x4A /* 'J' */
N#define ASCII_CHAR_LATIN_UPPER_K 0x4B /* 'K' */
N#define ASCII_CHAR_LATIN_UPPER_L 0x4C /* 'L' */
N#define ASCII_CHAR_LATIN_UPPER_M 0x4D /* 'M' */
N#define ASCII_CHAR_LATIN_UPPER_N 0x4E /* 'N' */
N#define ASCII_CHAR_LATIN_UPPER_O 0x4F /* 'O' */
N#define ASCII_CHAR_LATIN_UPPER_P 0x50 /* 'P' */
N#define ASCII_CHAR_LATIN_UPPER_Q 0x51 /* 'Q' */
N#define ASCII_CHAR_LATIN_UPPER_R 0x52 /* 'R' */
N#define ASCII_CHAR_LATIN_UPPER_S 0x53 /* 'S' */
N#define ASCII_CHAR_LATIN_UPPER_T 0x54 /* 'T' */
N#define ASCII_CHAR_LATIN_UPPER_U 0x55 /* 'U' */
N#define ASCII_CHAR_LATIN_UPPER_V 0x56 /* 'V' */
N#define ASCII_CHAR_LATIN_UPPER_W 0x57 /* 'W' */
N#define ASCII_CHAR_LATIN_UPPER_X 0x58 /* 'X' */
N#define ASCII_CHAR_LATIN_UPPER_Y 0x59 /* 'Y' */
N#define ASCII_CHAR_LATIN_UPPER_Z 0x5A /* 'Z' */
N
N
N /* ------------ ASCII PUNCTUATION & SYMBOLS ----------- */
N#define ASCII_CHAR_LEFT_SQUARE_BRACKET 0x5B /* '[' */
N#define ASCII_CHAR_REVERSE_SOLIDUS 0x5C /* '\\' */
N#define ASCII_CHAR_RIGHT_SQUARE_BRACKET 0x5D /* ']' */
N#define ASCII_CHAR_CIRCUMFLEX_ACCENT 0x5E /* '^' */
N#define ASCII_CHAR_LOW_LINE 0x5F /* '_' */
N#define ASCII_CHAR_GRAVE_ACCENT 0x60 /* '`' */
N
N#define ASCII_CHAR_BRACKET_SQUARE_LEFT ASCII_CHAR_LEFT_SQUARE_BRACKET
N#define ASCII_CHAR_BRACKET_SQUARE_RIGHT ASCII_CHAR_RIGHT_SQUARE_BRACKET
N
N
N /* ------------- LOWERCASE LATIN ALPHABET ------------- */
N#define ASCII_CHAR_LATIN_LOWER_A 0x61 /* 'a' */
N#define ASCII_CHAR_LATIN_LOWER_B 0x62 /* 'b' */
N#define ASCII_CHAR_LATIN_LOWER_C 0x63 /* 'c' */
N#define ASCII_CHAR_LATIN_LOWER_D 0x64 /* 'd' */
N#define ASCII_CHAR_LATIN_LOWER_E 0x65 /* 'e' */
N#define ASCII_CHAR_LATIN_LOWER_F 0x66 /* 'f' */
N#define ASCII_CHAR_LATIN_LOWER_G 0x67 /* 'g' */
N#define ASCII_CHAR_LATIN_LOWER_H 0x68 /* 'h' */
N#define ASCII_CHAR_LATIN_LOWER_I 0x69 /* 'i' */
N#define ASCII_CHAR_LATIN_LOWER_J 0x6A /* 'j' */
N#define ASCII_CHAR_LATIN_LOWER_K 0x6B /* 'k' */
N#define ASCII_CHAR_LATIN_LOWER_L 0x6C /* 'l' */
N#define ASCII_CHAR_LATIN_LOWER_M 0x6D /* 'm' */
N#define ASCII_CHAR_LATIN_LOWER_N 0x6E /* 'n' */
N#define ASCII_CHAR_LATIN_LOWER_O 0x6F /* 'o' */
N#define ASCII_CHAR_LATIN_LOWER_P 0x70 /* 'p' */
N#define ASCII_CHAR_LATIN_LOWER_Q 0x71 /* 'q' */
N#define ASCII_CHAR_LATIN_LOWER_R 0x72 /* 'r' */
N#define ASCII_CHAR_LATIN_LOWER_S 0x73 /* 's' */
N#define ASCII_CHAR_LATIN_LOWER_T 0x74 /* 't' */
N#define ASCII_CHAR_LATIN_LOWER_U 0x75 /* 'u' */
N#define ASCII_CHAR_LATIN_LOWER_V 0x76 /* 'v' */
N#define ASCII_CHAR_LATIN_LOWER_W 0x77 /* 'w' */
N#define ASCII_CHAR_LATIN_LOWER_X 0x78 /* 'x' */
N#define ASCII_CHAR_LATIN_LOWER_Y 0x79 /* 'y' */
N#define ASCII_CHAR_LATIN_LOWER_Z 0x7A /* 'z' */
N
N
N /* ------------ ASCII PUNCTUATION & SYMBOLS ----------- */
N#define ASCII_CHAR_LEFT_CURLY_BRACKET 0x7B /* '{' */
N#define ASCII_CHAR_VERTICAL_LINE 0x7C /* '|' */
N#define ASCII_CHAR_RIGHT_CURLY_BRACKET 0x7D /* '}' */
N#define ASCII_CHAR_TILDE 0x7E /* '~' */
N
N#define ASCII_CHAR_BRACKET_CURLY_LEFT ASCII_CHAR_LEFT_CURLY_BRACKET
N#define ASCII_CHAR_BRACKET_CURLY_RIGHT ASCII_CHAR_RIGHT_CURLY_BRACKET
N
N
N /* ---------------- CONTROL CHARACTERS ---------------- */
N#define ASCII_CHAR_DELETE 0x7F
N
N#define ASCII_CHAR_DEL ASCII_CHAR_DELETE
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DATA TYPES
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* GLOBAL VARIABLES
N*********************************************************************************************************
N*/
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* MACRO'S
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* ASCII CHARACTER CLASSIFICATION MACRO's
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.(1) states that "character classification functions ...
N* return nonzero (true) if and only if the value of the argument 'c' conforms to ... the
N* description of the function."
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* ASCII_IS_DIG()
N*
N* Description : Determine whether a character is a decimal-digit character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a decimal-digit character.
N*
N* DEF_NO, if character is NOT a decimal-digit character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.5.(2) states that "isdigit() ... tests for any
N* decimal-digit character".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_DIG(c) ((((c) >= ASCII_CHAR_DIG_ZERO) && ((c) <= ASCII_CHAR_DIG_NINE)) ? (DEF_YES) : (DEF_NO))
N
N
N/*
N*********************************************************************************************************
N* ASCII_IS_DIG_OCT()
N*
N* Description : Determine whether a character is an octal-digit character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is an octal-digit character.
N*
N* DEF_NO, if character is NOT an octal-digit character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : none.
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_DIG_OCT(c) ((((c) >= ASCII_CHAR_DIG_ZERO) && ((c) <= ASCII_CHAR_DIG_SEVEN)) ? (DEF_YES) : (DEF_NO))
N
N
N/*
N*********************************************************************************************************
N* ASCII_IS_DIG_HEX()
N*
N* Description : Determine whether a character is a hexadecimal-digit character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a hexadecimal-digit character.
N*
N* DEF_NO, if character is NOT a hexadecimal-digit character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.12.(2) states that "isxdigit() ... tests for any
N* hexadecimal-digit character".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_DIG_HEX(c) (((((c) >= ASCII_CHAR_DIG_ZERO ) && ((c) <= ASCII_CHAR_DIG_NINE )) || \
N (((c) >= ASCII_CHAR_LATIN_UPPER_A) && ((c) <= ASCII_CHAR_LATIN_UPPER_F)) || \
N (((c) >= ASCII_CHAR_LATIN_LOWER_A) && ((c) <= ASCII_CHAR_LATIN_LOWER_F))) ? (DEF_YES) : (DEF_NO))
X#define ASCII_IS_DIG_HEX(c) (((((c) >= ASCII_CHAR_DIG_ZERO ) && ((c) <= ASCII_CHAR_DIG_NINE )) || (((c) >= ASCII_CHAR_LATIN_UPPER_A) && ((c) <= ASCII_CHAR_LATIN_UPPER_F)) || (((c) >= ASCII_CHAR_LATIN_LOWER_A) && ((c) <= ASCII_CHAR_LATIN_LOWER_F))) ? (DEF_YES) : (DEF_NO))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ASCII_IS_LOWER()
N*
N* Description : Determine whether a character is a lowercase alphabetic character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a lowercase alphabetic character.
N*
N* DEF_NO, if character is NOT a lowercase alphabetic character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.7.(2) states that "islower() returns true only for
N* the lowercase letters".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_LOWER(c) ((((c) >= ASCII_CHAR_LATIN_LOWER_A) && ((c) <= ASCII_CHAR_LATIN_LOWER_Z)) ? (DEF_YES) : (DEF_NO))
N
N
N/*
N*********************************************************************************************************
N* ASCII_IS_UPPER()
N*
N* Description : Determine whether a character is an uppercase alphabetic character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is an uppercase alphabetic character.
N*
N* DEF_NO, if character is NOT an uppercase alphabetic character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.11.(2) states that "isupper() returns true only for
N* the uppercase letters".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_UPPER(c) ((((c) >= ASCII_CHAR_LATIN_UPPER_A) && ((c) <= ASCII_CHAR_LATIN_UPPER_Z)) ? (DEF_YES) : (DEF_NO))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ASCII_IS_ALPHA()
N*
N* Description : Determine whether a character is an alphabetic character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is an alphabetic character.
N*
N* DEF_NO, if character is NOT an alphabetic character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.2.(2) states that "isalpha() returns true only for the
N* characters for which isupper() or islower() is true".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_ALPHA(c) ((((ASCII_IS_UPPER(c)) == DEF_YES) || \
N ((ASCII_IS_LOWER(c)) == DEF_YES)) ? (DEF_YES) : (DEF_NO))
X#define ASCII_IS_ALPHA(c) ((((ASCII_IS_UPPER(c)) == DEF_YES) || ((ASCII_IS_LOWER(c)) == DEF_YES)) ? (DEF_YES) : (DEF_NO))
N
N
N/*
N*********************************************************************************************************
N* ASCII_IS_ALPHA_NUM()
N*
N* Description : Determine whether a character is an alphanumeric character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is an alphanumeric character.
N*
N* DEF_NO, if character is NOT an alphanumeric character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.1.(2) states that "isalnum() ... tests for any character
N* for which isalpha() or isdigit() is true".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_ALPHA_NUM(c) ((((ASCII_IS_ALPHA(c)) == DEF_YES) || \
N ((ASCII_IS_DIG (c)) == DEF_YES)) ? (DEF_YES) : (DEF_NO))
X#define ASCII_IS_ALPHA_NUM(c) ((((ASCII_IS_ALPHA(c)) == DEF_YES) || ((ASCII_IS_DIG (c)) == DEF_YES)) ? (DEF_YES) : (DEF_NO))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ASCII_IS_BLANK()
N*
N* Description : Determine whether a character is a standard blank character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a standard blank character.
N*
N* DEF_NO, if character is NOT a standard blank character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) ISO/IEC 9899:TC2, Section 7.4.1.3.(2) states that "isblank() returns true only for
N* the standard blank characters".
N*
N* (b) ISO/IEC 9899:TC2, Section 7.4.1.3.(2) defines "the standard blank characters" as
N* the "space (' '), and horizontal tab ('\t')".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_BLANK(c) ((((c) == ASCII_CHAR_SPACE) || ((c) == ASCII_CHAR_HT)) ? (DEF_YES) : (DEF_NO))
N
N
N/*
N*********************************************************************************************************
N* ASCII_IS_SPACE()
N*
N* Description : Determine whether a character is a white-space character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a white-space character.
N*
N* DEF_NO, if character is NOT a white-space character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) ISO/IEC 9899:TC2, Section 7.4.1.10.(2) states that "isspace() returns true only
N* for the standard white-space characters".
N*
N* (b) ISO/IEC 9899:TC2, Section 7.4.1.10.(2) defines "the standard white-space characters"
N* as the "space (' '), form feed ('\f'), new-line ('\n'), carriage return ('\r'),
N* horizontal tab ('\t'), and vertical tab ('\v')".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_SPACE(c) ((((c) == ASCII_CHAR_SPACE) || ((c) == ASCII_CHAR_CR) || \
N ((c) == ASCII_CHAR_LF ) || ((c) == ASCII_CHAR_FF) || \
N ((c) == ASCII_CHAR_HT ) || ((c) == ASCII_CHAR_VT)) ? (DEF_YES) : (DEF_NO))
X#define ASCII_IS_SPACE(c) ((((c) == ASCII_CHAR_SPACE) || ((c) == ASCII_CHAR_CR) || ((c) == ASCII_CHAR_LF ) || ((c) == ASCII_CHAR_FF) || ((c) == ASCII_CHAR_HT ) || ((c) == ASCII_CHAR_VT)) ? (DEF_YES) : (DEF_NO))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ASCII_IS_PRINT()
N*
N* Description : Determine whether a character is a printing character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a printing character.
N*
N* DEF_NO, if character is NOT a printing character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) ISO/IEC 9899:TC2, Section 7.4.1.8.(2) states that "isprint() ... tests for any
N* printing character including space (' ')".
N*
N* (b) ISO/IEC 9899:TC2, Section 7.4.(3), Note 169, states that in "the seven-bit US
N* ASCII character set, the printing characters are those whose values lie from
N* 0x20 (space) through 0x7E (tilde)".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_PRINT(c) ((((c) >= ASCII_CHAR_SPACE) && ((c) <= ASCII_CHAR_TILDE)) ? (DEF_YES) : (DEF_NO))
N
N
N/*
N*********************************************************************************************************
N* ASCII_IS_GRAPH()
N*
N* Description : Determine whether a character is any printing character except a space character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a graphic character.
N*
N* DEF_NO, if character is NOT a graphic character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) ISO/IEC 9899:TC2, Section 7.4.1.6.(2) states that "isgraph() ... tests for any
N* printing character except space (' ')".
N*
N* (b) ISO/IEC 9899:TC2, Section 7.4.(3), Note 169, states that in "the seven-bit US
N* ASCII character set, the printing characters are those whose values lie from
N* 0x20 (space) through 0x7E (tilde)".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_GRAPH(c) ((((c) >= ASCII_CHAR_EXCLAMATION_MARK) && ((c) <= ASCII_CHAR_TILDE)) ? (DEF_YES) : (DEF_NO))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ASCII_IS_PUNCT()
N*
N* Description : Determine whether a character is a punctuation character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a punctuation character.
N*
N* DEF_NO, if character is NOT a punctuation character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) ISO/IEC 9899:TC2, Section 7.4.1.9.(2) states that "ispunct() returns true for every
N* printing character for which neither isspace() nor isalnum() is true".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_PUNCT(c) ((((ASCII_IS_PRINT(c)) == DEF_YES) && \
N ((ASCII_IS_SPACE(c)) == DEF_NO ) && \
N ((ASCII_IS_ALPHA_NUM(c)) == DEF_NO )) ? (DEF_YES) : (DEF_NO))
X#define ASCII_IS_PUNCT(c) ((((ASCII_IS_PRINT(c)) == DEF_YES) && ((ASCII_IS_SPACE(c)) == DEF_NO ) && ((ASCII_IS_ALPHA_NUM(c)) == DEF_NO )) ? (DEF_YES) : (DEF_NO))
N
N
N/*
N*********************************************************************************************************
N* ASCII_IS_CTRL()
N*
N* Description : Determine whether a character is a control character.
N*
N* Argument(s) : c Character to examine.
N*
N* Return(s) : DEF_YES, if character is a control character.
N*
N* DEF_NO, if character is NOT a control character.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) ISO/IEC 9899:TC2, Section 7.4.1.4.(2) states that "iscntrl() ... tests for any
N* control character".
N*
N* (b) ISO/IEC 9899:TC2, Section 7.4.(3), Note 169, states that in "the seven-bit US
N* ASCII character set, ... the control characters are those whose values lie from
N* 0 (NUL) through 0x1F (US), and the character 0x7F (DEL)".
N*********************************************************************************************************
N*/
N
N#define ASCII_IS_CTRL(c) (((((CPU_INT08S)(c) >= ASCII_CHAR_NULL ) && ((c) <= ASCII_CHAR_IS1)) || \
N ((c) == ASCII_CHAR_DEL)) ? (DEF_YES) : (DEF_NO))
X#define ASCII_IS_CTRL(c) (((((CPU_INT08S)(c) >= ASCII_CHAR_NULL ) && ((c) <= ASCII_CHAR_IS1)) || ((c) == ASCII_CHAR_DEL)) ? (DEF_YES) : (DEF_NO))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* ASCII CHARACTER CASE MAPPING MACRO's
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* ASCII_TO_LOWER()
N*
N* Description : Convert uppercase alphabetic character to its corresponding lowercase alphabetic character.
N*
N* Argument(s) : c Character to convert.
N*
N* Return(s) : Lowercase equivalent of 'c', if character 'c' is an uppercase character (see Note #1b1).
N*
N* Character 'c', otherwise (see Note #1b2).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) ISO/IEC 9899:TC2, Section 7.4.2.1.(2) states that "tolower() ... converts an
N* uppercase letter to a corresponding lowercase letter".
N*
N* (b) ISO/IEC 9899:TC2, Section 7.4.2.1.(3) states that :
N*
N* (1) (A) "if the argument is a character for which isupper() is true and there are
N* one or more corresponding characters ... for which islower() is true," ...
N* (B) "tolower() ... returns one of the corresponding characters;" ...
N*
N* (2) "otherwise, the argument is returned unchanged."
N*********************************************************************************************************
N*/
N
N#define ASCII_TO_LOWER(c) (((ASCII_IS_UPPER(c)) == DEF_YES) ? ((c) + (ASCII_CHAR_LATIN_LOWER_A - ASCII_CHAR_LATIN_UPPER_A)) : (c))
N
N
N/*
N*********************************************************************************************************
N* ASCII_TO_UPPER()
N*
N* Description : Convert lowercase alphabetic character to its corresponding uppercase alphabetic character.
N*
N* Argument(s) : c Character to convert.
N*
N* Return(s) : Uppercase equivalent of 'c', if character 'c' is a lowercase character (see Note #1b1).
N*
N* Character 'c', otherwise (see Note #1b2).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) ISO/IEC 9899:TC2, Section 7.4.2.2.(2) states that "toupper() ... converts a
N* lowercase letter to a corresponding uppercase letter".
N*
N* (b) ISO/IEC 9899:TC2, Section 7.4.2.2.(3) states that :
N*
N* (1) (A) "if the argument is a character for which islower() is true and there are
N* one or more corresponding characters ... for which isupper() is true," ...
N* (B) "toupper() ... returns one of the corresponding characters;" ...
N*
N* (2) "otherwise, the argument is returned unchanged."
N*********************************************************************************************************
N*/
N
N#define ASCII_TO_UPPER(c) (((ASCII_IS_LOWER(c)) == DEF_YES) ? ((c) - (ASCII_CHAR_LATIN_LOWER_A - ASCII_CHAR_LATIN_UPPER_A)) : (c))
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* FUNCTION PROTOTYPES
N*********************************************************************************************************
N*/
N
NCPU_BOOLEAN ASCII_IsAlpha (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsAlphaNum(CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsLower (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsUpper (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsDig (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsDigOct (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsDigHex (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsBlank (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsSpace (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsPrint (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsGraph (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsPunct (CPU_CHAR c);
N
NCPU_BOOLEAN ASCII_IsCtrl (CPU_CHAR c);
N
N
NCPU_CHAR ASCII_ToLower (CPU_CHAR c);
N
NCPU_CHAR ASCII_ToUpper (CPU_CHAR c);
N
N
NCPU_BOOLEAN ASCII_Cmp (CPU_CHAR c1,
N CPU_CHAR c2);
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CONFIGURATION ERRORS
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE END
N*
N* Note(s) : (1) See 'lib_ascii.h MODULE'.
N*********************************************************************************************************
N*/
N
N#endif /* End of lib ascii module include. */
N
L 159 "..\..\uCOS-III\uC-LIB\lib_str.h" 2
N
N#include <lib_cfg.h>
L 1 "..\..\User\lib_cfg.h" 1
N/*
N*********************************************************************************************************
N* uC/LIB
N* CUSTOM LIBRARY MODULES
N*
N* (c) Copyright 2004-2013; Micrium, Inc.; Weston, FL
N*
N* All rights reserved. Protected by international copyright laws.
N*
N* uC/LIB is provided in source form to registered licensees ONLY. It is
N* illegal to distribute this source code to any third party unless you receive
N* written permission by an authorized Micrium representative. Knowledge of
N* the source code may NOT be used to develop a similar product.
N*
N* Please help us continue to provide the Embedded community with the finest
N* software available. Your honesty is greatly appreciated.
N*
N* You can contact us at www.micrium.com.
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N*
N* CUSTOM LIBRARY CONFIGURATION FILE
N*
N* ST Microelectronics STM32
N* on the
N*
N* STM3240G-EVAL
N* Evaluation Board
N*
N* Filename : lib_cfg.h
N* Version : V1.35.00
N* Programmer(s) : DC
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* MODULE
N*********************************************************************************************************
N*/
N
N#ifndef LIB_CFG_MODULE_PRESENT
N#define LIB_CFG_MODULE_PRESENT
N
N
N/*
N*********************************************************************************************************
N* uC/LIB CONFIGURATION
N*********************************************************************************************************
N*/
N
N#define LIB_MEM_CFG_ARG_CHK_EXT_EN DEF_ENABLED
N /* DEF_DISABLED Argument check DISABLED */
N /* DEF_ENABLED Argument check ENABLED */
N
N#define LIB_MEM_CFG_OPTIMIZE_ASM_EN DEF_ENABLED
N /* DEF_DISABLED Assembly-optimized function(s) DISABLED */
N /* DEF_ENABLED Assembly-optimized function(s) ENABLED */
N
N#define LIB_MEM_CFG_ALLOC_EN DEF_ENABLED
N /* DEF_DISABLED Memory allocation DISABLED */
N /* DEF_ENABLED Memory allocation ENABLED */
N
N
N#define LIB_MEM_CFG_HEAP_SIZE 23u * 1024u /* Configure Heap Memory Size */
N
N
N/*
N*********************************************************************************************************
N* MODULE END
N*********************************************************************************************************
N*/
N
N#endif /* End of lib cfg module include. */
N
L 161 "..\..\uCOS-III\uC-LIB\lib_str.h" 2
N
N#if 0 /* See Note #4. */
S#include <stdio.h>
N#endif
N
N
N/*
N*********************************************************************************************************
N* EXTERNS
N*********************************************************************************************************
N*/
N
N#ifdef LIB_STR_MODULE
N#define LIB_STR_EXT
N#else
S#define LIB_STR_EXT extern
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* DEFAULT CONFIGURATION
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* STRING FLOATING POINT CONFIGURATION
N*
N* Note(s) : (1) Configure LIB_STR_CFG_FP_EN to enable/disable floating point string function(s).
N*
N* (2) Configure LIB_STR_CFG_FP_MAX_NBR_DIG_SIG to configure the maximum number of significant
N* digits to calculate &/or display for floating point string function(s).
N*
N* See also 'STRING FLOATING POINT DEFINES Note #1'.
N*********************************************************************************************************
N*/
N
N /* Configure floating point feature(s) [see Note #1] : */
N#ifndef LIB_STR_CFG_FP_EN
N#define LIB_STR_CFG_FP_EN DEF_DISABLED
N /* DEF_DISABLED Floating point functions DISABLED */
N /* DEF_ENABLED Floating point functions ENABLED */
N#endif
N
N /* Configure floating point feature(s)' number of ... */
N /* ... significant digits (see Note #2). */
N#ifndef LIB_STR_CFG_FP_MAX_NBR_DIG_SIG
N#define LIB_STR_CFG_FP_MAX_NBR_DIG_SIG LIB_STR_FP_MAX_NBR_DIG_SIG_DFLT
N#endif
N
N
N/*
N*********************************************************************************************************
N* DEFINES
N*********************************************************************************************************
N*/
N
N#define STR_CR_LF "\r\n"
N#define STR_LF_CR "\n\r"
N#define STR_NEW_LINE STR_CR_LF
N#define STR_PARENT_PATH ".."
N
N#define STR_CR_LF_LEN (sizeof(STR_CR_LF) - 1)
N#define STR_LF_CR_LEN (sizeof(STR_LF_CR) - 1)
N#define STR_NEW_LINE_LEN (sizeof(STR_NEW_LINE) - 1)
N#define STR_PARENT_PATH_LEN (sizeof(STR_PARENT_PATH) - 1)
N
N
N/*
N*********************************************************************************************************
N* DATA TYPES
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* GLOBAL VARIABLES
N*********************************************************************************************************
N*/
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* MACRO'S
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* STANDARD LIBRARY MACRO'S
N*
N* Note(s) : (1) NO compiler-supplied standard library functions SHOULD be used.
N*
N* #### The reference to standard memory functions SHOULD be removed once all custom library
N* functions are implemented WITHOUT reference to ANY standard library function(s).
N*
N* See also 'INCLUDE FILES Note #3'.
N*********************************************************************************************************
N*/
N
N /* See Note #1. */
N#define Str_FmtPrint snprintf
N#define Str_FmtScan sscanf
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* FUNCTION PROTOTYPES
N*********************************************************************************************************
N*/
N
N /* ------------------ STR LEN FNCTS ------------------ */
NCPU_SIZE_T Str_Len (const CPU_CHAR *pstr);
N
NCPU_SIZE_T Str_Len_N (const CPU_CHAR *pstr,
N CPU_SIZE_T len_max);
N
N
N /* ------------------ STR COPY FNCTS ------------------ */
NCPU_CHAR *Str_Copy ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_src);
N
NCPU_CHAR *Str_Copy_N ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_src,
N CPU_SIZE_T len_max);
N
N
NCPU_CHAR *Str_Cat ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_cat);
N
NCPU_CHAR *Str_Cat_N ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_cat,
N CPU_SIZE_T len_max);
N
N
N /* ------------------ STR CMP FNCTS ------------------ */
NCPU_INT16S Str_Cmp (const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str);
N
NCPU_INT16S Str_Cmp_N (const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str,
N CPU_SIZE_T len_max);
N
NCPU_INT16S Str_CmpIgnoreCase (const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str);
N
NCPU_INT16S Str_CmpIgnoreCase_N(const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str,
N CPU_SIZE_T len_max);
N
N
N /* ------------------ STR SRCH FNCTS ------------------ */
NCPU_CHAR *Str_Char (const CPU_CHAR *pstr,
N CPU_CHAR srch_char);
N
NCPU_CHAR *Str_Char_N (const CPU_CHAR *pstr,
N CPU_SIZE_T len_max,
N CPU_CHAR srch_char);
N
NCPU_CHAR *Str_Char_Last (const CPU_CHAR *pstr,
N CPU_CHAR srch_char);
N
NCPU_CHAR *Str_Char_Last_N (const CPU_CHAR *pstr,
N CPU_SIZE_T len_max,
N CPU_CHAR srch_char);
N
NCPU_CHAR *Str_Char_Replace ( CPU_CHAR *pstr,
N CPU_CHAR char_srch,
N CPU_CHAR char_replace);
N
NCPU_CHAR *Str_Char_Replace_N ( CPU_CHAR *pstr,
N CPU_CHAR char_srch,
N CPU_CHAR char_replace,
N CPU_SIZE_T len_max);
N
NCPU_CHAR *Str_Str (const CPU_CHAR *pstr,
N const CPU_CHAR *pstr_srch);
N
NCPU_CHAR *Str_Str_N (const CPU_CHAR *pstr,
N const CPU_CHAR *pstr_srch,
N CPU_SIZE_T len_max);
N
N
N/*$PAGE*/
N /* ------------------ STR FMT FNCTS ------------------ */
NCPU_CHAR *Str_FmtNbr_Int32U ( CPU_INT32U nbr,
N CPU_INT08U nbr_dig,
N CPU_INT08U nbr_base,
N CPU_CHAR lead_char,
N CPU_BOOLEAN lower_case,
N CPU_BOOLEAN nul,
N CPU_CHAR *pstr);
N
NCPU_CHAR *Str_FmtNbr_Int32S ( CPU_INT32S nbr,
N CPU_INT08U nbr_dig,
N CPU_INT08U nbr_base,
N CPU_CHAR lead_char,
N CPU_BOOLEAN lower_case,
N CPU_BOOLEAN nul,
N CPU_CHAR *pstr);
N
N#if (LIB_STR_CFG_FP_EN == DEF_ENABLED)
X#if (0u == 1u)
SCPU_CHAR *Str_FmtNbr_32 ( CPU_FP32 nbr,
S CPU_INT08U nbr_dig,
S CPU_INT08U nbr_dp,
S CPU_CHAR lead_char,
S CPU_BOOLEAN nul,
S CPU_CHAR *pstr);
N#endif
N
N
N /* ----------------- STR PARSE FNCTS ------------------ */
NCPU_INT32U Str_ParseNbr_Int32U(const CPU_CHAR *pstr,
N CPU_CHAR **pstr_next,
N CPU_INT08U nbr_base);
N
NCPU_INT32S Str_ParseNbr_Int32S(const CPU_CHAR *pstr,
N CPU_CHAR **pstr_next,
N CPU_INT08U nbr_base);
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* CONFIGURATION ERRORS
N*********************************************************************************************************
N*/
N
N#ifndef LIB_STR_CFG_FP_EN
S#error "LIB_STR_CFG_FP_EN not #define'd in 'lib_cfg.h'"
S#error " [MUST be DEF_DISABLED] "
S#error " [ || DEF_ENABLED ] "
S
S#elif ((LIB_STR_CFG_FP_EN != DEF_DISABLED) && \
S (LIB_STR_CFG_FP_EN != DEF_ENABLED ))
X#elif ((0u != 0u) && (0u != 1u ))
S#error "LIB_STR_CFG_FP_EN illegally #define'd in 'lib_cfg.h'"
S#error " [MUST be DEF_DISABLED] "
S#error " [ || DEF_ENABLED ] "
S
S
S#elif (LIB_STR_CFG_FP_EN == DEF_ENABLED)
X#elif (0u == 1u)
S
S#ifndef LIB_STR_CFG_FP_MAX_NBR_DIG_SIG
S#error "LIB_STR_CFG_FP_MAX_NBR_DIG_SIG not #define'd in 'lib_cfg.h' "
S#error " [MUST be >= LIB_STR_FP_MAX_NBR_DIG_SIG_MIN]"
S#error " [ && <= LIB_STR_FP_MAX_NBR_DIG_SIG_MAX]"
S
S#elif (DEF_CHK_VAL(LIB_STR_CFG_FP_MAX_NBR_DIG_SIG, \
S LIB_STR_FP_MAX_NBR_DIG_SIG_MIN, \
S LIB_STR_FP_MAX_NBR_DIG_SIG_MAX) != DEF_OK)
X#elif (DEF_CHK_VAL(LIB_STR_CFG_FP_MAX_NBR_DIG_SIG, LIB_STR_FP_MAX_NBR_DIG_SIG_MIN, LIB_STR_FP_MAX_NBR_DIG_SIG_MAX) != DEF_OK)
S#error "LIB_STR_CFG_FP_MAX_NBR_DIG_SIG illegally #define'd in 'lib_cfg.h' "
S#error " [MUST be >= LIB_STR_FP_MAX_NBR_DIG_SIG_MIN]"
S#error " [ && <= LIB_STR_FP_MAX_NBR_DIG_SIG_MAX]"
S#endif
S
N#endif
N
N
N/*
N*********************************************************************************************************
N* MODULE END
N*
N* Note(s) : (1) See 'lib_str.h MODULE'.
N*********************************************************************************************************
N*/
N
N#endif /* End of lib str module include. */
N
L 71 "..\..\uCOS-III\uC-LIB\lib_str.c" 2
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* LOCAL DEFINES
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* LOCAL CONSTANTS
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* LOCAL DATA TYPES
N*********************************************************************************************************
N*/
N
N
N/*
N*********************************************************************************************************
N* LOCAL TABLES
N*********************************************************************************************************
N*/
N
Nstatic const CPU_INT32U Str_MultOvfThTbl_Int32U[] = {
N (CPU_INT32U) DEF_INT_32U_MAX_VAL, /* Invalid base 0. */
X (CPU_INT32U) 4294967295u,
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 1u), /* Invalid base 1. */
X (CPU_INT32U)(4294967295u / 1u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 2u), /* 32-bit mult ovf th for base 2. */
X (CPU_INT32U)(4294967295u / 2u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 3u), /* 32-bit mult ovf th for base 3. */
X (CPU_INT32U)(4294967295u / 3u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 4u), /* 32-bit mult ovf th for base 4. */
X (CPU_INT32U)(4294967295u / 4u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 5u), /* 32-bit mult ovf th for base 5. */
X (CPU_INT32U)(4294967295u / 5u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 6u), /* 32-bit mult ovf th for base 6. */
X (CPU_INT32U)(4294967295u / 6u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 7u), /* 32-bit mult ovf th for base 7. */
X (CPU_INT32U)(4294967295u / 7u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 8u), /* 32-bit mult ovf th for base 8. */
X (CPU_INT32U)(4294967295u / 8u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 9u), /* 32-bit mult ovf th for base 9. */
X (CPU_INT32U)(4294967295u / 9u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 10u), /* 32-bit mult ovf th for base 10. */
X (CPU_INT32U)(4294967295u / 10u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 11u), /* 32-bit mult ovf th for base 11. */
X (CPU_INT32U)(4294967295u / 11u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 12u), /* 32-bit mult ovf th for base 12. */
X (CPU_INT32U)(4294967295u / 12u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 13u), /* 32-bit mult ovf th for base 13. */
X (CPU_INT32U)(4294967295u / 13u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 14u), /* 32-bit mult ovf th for base 14. */
X (CPU_INT32U)(4294967295u / 14u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 15u), /* 32-bit mult ovf th for base 15. */
X (CPU_INT32U)(4294967295u / 15u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 16u), /* 32-bit mult ovf th for base 16. */
X (CPU_INT32U)(4294967295u / 16u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 17u), /* 32-bit mult ovf th for base 17. */
X (CPU_INT32U)(4294967295u / 17u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 18u), /* 32-bit mult ovf th for base 18. */
X (CPU_INT32U)(4294967295u / 18u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 19u), /* 32-bit mult ovf th for base 19. */
X (CPU_INT32U)(4294967295u / 19u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 20u), /* 32-bit mult ovf th for base 20. */
X (CPU_INT32U)(4294967295u / 20u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 21u), /* 32-bit mult ovf th for base 21. */
X (CPU_INT32U)(4294967295u / 21u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 22u), /* 32-bit mult ovf th for base 22. */
X (CPU_INT32U)(4294967295u / 22u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 23u), /* 32-bit mult ovf th for base 23. */
X (CPU_INT32U)(4294967295u / 23u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 24u), /* 32-bit mult ovf th for base 24. */
X (CPU_INT32U)(4294967295u / 24u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 25u), /* 32-bit mult ovf th for base 25. */
X (CPU_INT32U)(4294967295u / 25u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 26u), /* 32-bit mult ovf th for base 26. */
X (CPU_INT32U)(4294967295u / 26u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 27u), /* 32-bit mult ovf th for base 27. */
X (CPU_INT32U)(4294967295u / 27u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 28u), /* 32-bit mult ovf th for base 28. */
X (CPU_INT32U)(4294967295u / 28u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 29u), /* 32-bit mult ovf th for base 29. */
X (CPU_INT32U)(4294967295u / 29u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 30u), /* 32-bit mult ovf th for base 30. */
X (CPU_INT32U)(4294967295u / 30u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 31u), /* 32-bit mult ovf th for base 31. */
X (CPU_INT32U)(4294967295u / 31u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 32u), /* 32-bit mult ovf th for base 32. */
X (CPU_INT32U)(4294967295u / 32u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 33u), /* 32-bit mult ovf th for base 33. */
X (CPU_INT32U)(4294967295u / 33u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 34u), /* 32-bit mult ovf th for base 34. */
X (CPU_INT32U)(4294967295u / 34u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 35u), /* 32-bit mult ovf th for base 35. */
X (CPU_INT32U)(4294967295u / 35u),
N (CPU_INT32U)(DEF_INT_32U_MAX_VAL / 36u) /* 32-bit mult ovf th for base 36. */
X (CPU_INT32U)(4294967295u / 36u)
N};
N
N
N/*
N*********************************************************************************************************
N* LOCAL GLOBAL VARIABLES
N*********************************************************************************************************
N*/
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* LOCAL FUNCTION PROTOTYPES
N*********************************************************************************************************
N*/
N
Nstatic CPU_CHAR *Str_FmtNbr_Int32 ( CPU_INT32U nbr,
N CPU_INT08U nbr_dig,
N CPU_INT08U nbr_base,
N CPU_BOOLEAN nbr_neg,
N CPU_CHAR lead_char,
N CPU_BOOLEAN lower_case,
N CPU_BOOLEAN nul,
N CPU_CHAR *pstr);
N
Nstatic CPU_INT32U Str_ParseNbr_Int32(const CPU_CHAR *pstr,
N CPU_CHAR **pstr_next,
N CPU_INT08U nbr_base,
N CPU_BOOLEAN nbr_signed,
N CPU_BOOLEAN *pnbr_neg);
N
N
N/*
N*********************************************************************************************************
N* LOCAL CONFIGURATION ERRORS
N*********************************************************************************************************
N*/
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Len()
N*
N* Description : Calculate length of a string.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* Return(s) : Length of string; number of characters in string before terminating NULL character
N* (see Note #2b1).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strlen() : DESCRIPTION' states that :
N*
N* (1) "The strlen() function shall compute the number of bytes in the string to
N* which 's' ('pstr') points," ...
N* (2) "not including the terminating null byte."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strlen() : RETURN VALUE' states that :
N*
N* (1) "The strlen() function shall return the length of 's' ('pstr');" ...
N* (2) "no return value shall be reserved to indicate an error."
N*
N* (3) String length calculation terminates when :
N*
N* (a) String pointer points to NULL.
N* (1) String buffer overlaps with NULL address.
N* (2) String length calculated for string up to but NOT beyond or including
N* the NULL address.
N*
N* (b) Terminating NULL character found.
N* (1) String length calculated for string up to but NOT including
N* the NULL character (see Note #2a2).
N*********************************************************************************************************
N*/
N
NCPU_SIZE_T Str_Len (const CPU_CHAR *pstr)
N{
N CPU_SIZE_T len;
N
N
N len = Str_Len_N(pstr,
N DEF_INT_CPU_U_MAX_VAL);
X 4294967295u);
N
N return (len);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Len_N()
N*
N* Description : Calculate length of a string, up to a maximum number of characters.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* len_max Maximum number of characters to search (see Note #3c).
N*
N* Return(s) : Length of string; number of characters in string before terminating NULL character,
N* if terminating NULL character found (see Note #2b1).
N*
N* Requested maximum number of characters to search,
N* if terminating NULL character NOT found (see Note #3c).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strlen() : DESCRIPTION' states that :
N*
N* (1) "The strlen() function shall compute the number of bytes in the string to
N* which 's' ('pstr') points," ...
N* (2) "not including the terminating null byte."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strlen() : RETURN VALUE' states that :
N*
N* (1) "The strlen() function shall return the length of 's' ('pstr');" ...
N* (2) "no return value shall be reserved to indicate an error."
N*
N* (3) String length calculation terminates when :
N*
N* (a) String pointer points to NULL.
N* (1) String buffer overlaps with NULL address.
N* (2) String length calculated for string up to but NOT beyond or including
N* the NULL address.
N*
N* (b) Terminating NULL character found.
N* (1) String length calculated for string up to but NOT including
N* the NULL character (see Note #2a2).
N*
N* (c) 'len_max' number of characters searched.
N* (1) 'len_max' number of characters does NOT include the terminating NULL character.
N*********************************************************************************************************
N*/
N
NCPU_SIZE_T Str_Len_N (const CPU_CHAR *pstr,
N CPU_SIZE_T len_max)
N{
N const CPU_CHAR *pstr_len;
N CPU_SIZE_T len;
N
N
N pstr_len = pstr;
N len = 0u;
N while (( pstr_len != (const CPU_CHAR *) 0 ) && /* Calc str len until NULL ptr (see Note #3a) ... */
N (*pstr_len != ( CPU_CHAR )'\0') && /* ... or NULL char found (see Note #3b) ... */
N ( len < ( CPU_SIZE_T)len_max)) { /* ... or max nbr chars srch'd (see Note #3c). */
N pstr_len++;
N len++;
N }
N
N return (len); /* Rtn str len (see Note #3b1). */
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Copy()
N*
N* Description : Copy source string to destination string buffer.
N*
N* Argument(s) : pstr_dest Pointer to destination string buffer to receive source string copy (see Note #1a).
N*
N* pstr_src Pointer to source string to copy into destination string buffer (see Note #1b).
N*
N* Return(s) : Pointer to destination string, if NO error(s) [see Note #2b1].
N*
N* Pointer to NULL, otherwise (see Note #2b2A).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) Destination buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (1) Destination buffer size MUST be large enough to accommodate the entire source
N* string size including the terminating NULL character.
N*
N* (b) Source buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strcpy() : DESCRIPTION' states that :
N*
N* (1) "The strcpy() function shall copy the string pointed to by 's2' ('pstr_src')
N* ... into the array pointed to by 's1' ('pstr_dest')" ...
N* (2) "(including the terminating null byte)."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strcpy() : RETURN VALUE' states that :
N*
N* (1) "The strcpy() function shall return 's1' ('pstr_dest');" ...
N* (2) "no return value is reserved to indicate an error."
N* (A) #### This requirement is intentionally NOT implemented in order to return
N* NULL for any error(s).
N*
N* (c) IEEE Std 1003.1, 2004 Edition, Section 'strcpy() : DESCRIPTION' states that "if
N* copying takes place between objects that overlap, the behavior is undefined".
N*
N* (3) String copy terminates when :
N*
N* (a) Destination/Source string pointer(s) are passed NULL pointers.
N* (1) No string copy performed; NULL pointer returned.
N*
N* (b) Destination/Source string pointer(s) point to NULL.
N* (1) String buffer(s) overlap with NULL address; NULL pointer returned.
N*
N* (c) Source string's terminating NULL character found.
N* (1) Entire source string copied into destination string buffer (see Note #2a).
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_Copy ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_src)
N{
N CPU_CHAR *pstr_rtn;
N
N
N pstr_rtn = Str_Copy_N(pstr_dest,
N pstr_src,
N DEF_INT_CPU_U_MAX_VAL);
X 4294967295u);
N
N return (pstr_rtn);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Copy_N()
N*
N* Description : Copy source string to destination string buffer, up to a maximum number of characters.
N*
N* Argument(s) : pstr_dest Pointer to destination string buffer to receive source string copy (see Note #1a).
N*
N* pstr_src Pointer to source string to copy into destination string buffer (see Note #1b).
N*
N* len_max Maximum number of characters to copy (see Notes #2a2 & #3d).
N*
N* Return(s) : Pointer to destination string, if NO error(s) [see Note #2b1].
N*
N* Pointer to NULL, otherwise (see Note #2b2A).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) Destination buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (1) Destination buffer size MUST be large enough to accommodate the entire source
N* string size including the terminating NULL character.
N*
N* (b) Source string buffer NOT modified.
N*
N* (2) (a) (1) IEEE Std 1003.1, 2004 Edition, Section 'strncpy() : DESCRIPTION' states that :
N*
N* (A) "The strncpy() function shall copy ... the array pointed to by 's2'
N* ('pstr_src') to the array pointed to by 's1' ('pstr_dest')"; ...
N* (B) but "not more than 'n' ('len_max') bytes" ...
N* (C) & "(bytes that follow a null byte are not copied)".
N*
N* (2) (A) IEEE Std 1003.1, 2004 Edition, Section 'strncpy() : DESCRIPTION' adds that
N* "if the array pointed to by 's2' ('pstr_src') is a string that is shorter
N* than 'n' ('len_max') bytes, null bytes shall be appended to the copy in
N* the array pointed to by 's1' ('pstr_dest'), until 'n' ('len_max') bytes
N* in all are written."
N*
N* (1) #### Since Str_Copy() limits the maximum number of characters to copy
N* via Str_Copy_N() by the CPU's maximum number of addressable characters,
N* this requirement is intentionally NOT implemented to avoid appending
N* a potentially large number of unnecessary terminating NULL characters.
N*
N* (B) IEEE Std 1003.1, 2004 Edition, Section 'strncpy() : APPLICATION USAGE' also
N* states that "if there is no null byte in the first 'n' ('len_max') bytes of
N* the array pointed to by 's2' ('pstr_src'), the result is not null-terminated".
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strncpy() : RETURN VALUE' states that :
N*
N* (1) "The strncpy() function shall return 's1' ('pstr_dest');" ...
N* (2) "no return value is reserved to indicate an error."
N* (A) #### This requirement is intentionally ignored in order to return NULL
N* for any error(s).
N*
N* (c) IEEE Std 1003.1, 2004 Edition, Section 'strncpy() : DESCRIPTION' states that "if
N* copying takes place between objects that overlap, the behavior is undefined".
N*
N* (3) String copy terminates when :
N*
N* (a) Destination/Source string pointer(s) are passed NULL pointers.
N* (1) No string copy performed; NULL pointer returned.
N*
N* (b) Destination/Source string pointer(s) point to NULL.
N* (1) String buffer(s) overlap with NULL address; NULL pointer returned.
N*
N* (c) Source string's terminating NULL character found.
N* (1) Entire source string copied into destination string buffer (see Note #2a1A).
N*
N* (d) 'len_max' number of characters copied.
N* (1) 'len_max' number of characters MAY include the terminating NULL character
N* (see Note #2a1C).
N* (2) Null copies allowed (i.e. zero-length copies).
N* (A) No string copy performed; destination string returned (see Note #2b1).
N*********************************************************************************************************
N*/
N/*$PAGE*/
NCPU_CHAR *Str_Copy_N ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_src,
N CPU_SIZE_T len_max)
N{
N CPU_CHAR *pstr_copy_dest;
N const CPU_CHAR *pstr_copy_src;
N CPU_SIZE_T len_copy;
N
N /* Rtn NULL if str ptr(s) NULL (see Note #3a1). */
N if (pstr_dest == (CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N if (pstr_src == (const CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N
N
N pstr_copy_dest = pstr_dest;
N pstr_copy_src = pstr_src;
N len_copy = 0u;
N
N while (( pstr_copy_dest != ( CPU_CHAR *) 0 ) && /* Copy str until NULL ptr(s) [see Note #3b] ... */
N ( pstr_copy_src != (const CPU_CHAR *) 0 ) &&
N (*pstr_copy_src != ( CPU_CHAR )'\0') && /* ... or NULL char found (see Note #3c); ... */
N ( len_copy < ( CPU_SIZE_T)len_max)) { /* ... or max nbr chars copied (see Note #3d). */
N *pstr_copy_dest = *pstr_copy_src;
N pstr_copy_dest++;
N pstr_copy_src++;
N len_copy++;
N }
N /* Rtn NULL if NULL ptr(s) found (see Note #3b1). */
N if ((pstr_copy_dest == ( CPU_CHAR *)0) ||
N (pstr_copy_src == (const CPU_CHAR *)0)) {
N return ((CPU_CHAR *)0);
N }
N
N if (len_copy < len_max) { /* If copy str len < max buf len (see Note #2a2A), ... */
N *pstr_copy_dest = (CPU_CHAR)'\0'; /* ... copy NULL char (see Note #3c1). */
N }
N
N
N return (pstr_dest); /* Rtn ptr to dest str (see Note #2b1). */
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Cat()
N*
N* Description : Append concatenation string to destination string.
N*
N* Argument(s) : pstr_dest Pointer to destination string to append concatenation string (see Note #1a).
N*
N* pstr_cat Pointer to concatenation string to append to destination string (see Note #1b).
N*
N* Return(s) : Pointer to destination string, if NO error(s) [see Note #2b1].
N*
N* Pointer to NULL, otherwise (see Note #2b2A).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) Destination buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (1) Destination buffer size MUST be large enough to accommodate the entire
N* concatenated string size including the terminating NULL character.
N*
N* (b) Concatenation string buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strcat() : DESCRIPTION' states that :
N*
N* (1) "The strcat() function shall append a copy of the string pointed to by 's2'
N* ('pstr_cat') ... to the end of the string pointed to by 's1' ('pstr_dest')."
N*
N* (2) (A) "The initial byte of 's2' ('pstr_cat') overwrites the null byte at the
N* end of 's1' ('pstr_dest')."
N* (B) A "terminating null byte" is appended at the end of the concatenated
N* destination strings.
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strcat() : RETURN VALUE' states that :
N*
N* (1) "The strcat() function shall return 's1' ('pstr_dest');" ...
N* (2) "no return value shall be reserved to indicate an error."
N* (A) #### This requirement is intentionally NOT implemented in order to return
N* NULL for any error(s).
N*
N* (c) IEEE Std 1003.1, 2004 Edition, Section 'strcat() : DESCRIPTION' states that "if
N* copying takes place between objects that overlap, the behavior is undefined."
N*
N* (3) String concatenation terminates when :
N*
N* (a) Destination/Concatenation string pointer(s) are passed NULL pointers.
N* (1) No string concatenation performed; NULL pointer returned.
N*
N* (b) Destination/Concatenation string pointer(s) point to NULL.
N* (1) String buffer(s) overlap with NULL address; NULL pointer returned.
N*
N* (c) Concatenation string's terminating NULL character found.
N* (1) Entire concatenation string appended to destination string (see Note #2a1).
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_Cat ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_cat)
N{
N CPU_CHAR *pstr_rtn;
N
N
N pstr_rtn = Str_Cat_N(pstr_dest,
N pstr_cat,
N DEF_INT_CPU_U_MAX_VAL);
X 4294967295u);
N
N return (pstr_rtn);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Cat_N()
N*
N* Description : Append concatenation string to destination string, up to a maximum number of characters.
N*
N* Argument(s) : pstr_dest Pointer to destination string to append concatenation string (see Note #1a).
N*
N* pstr_cat Pointer to concatenation string to append to destination string (see Note #1b).
N*
N* len_max Maximum number of characters to concatenate (see Notes #2a1B & #3d).
N*
N* Return(s) : Pointer to destination string, if NO error(s) [see Note #2b1].
N*
N* Pointer to NULL, otherwise (see Note #2b2A).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) Destination buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (1) Destination buffer size MUST be large enough to accommodate the entire
N* concatenated string size including the terminating NULL character.
N*
N* (b) Concatenation string buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strncat() : DESCRIPTION' states that :
N*
N* (1) (A) "The strncat() function shall append ... the array pointed to by 's2'
N* ('pstr_cat') to the end of the string pointed to by 's1' ('pstr_dest')" ...
N* (B) but "not more than 'n' ('len_max') bytes".
N*
N* (2) (A) "The initial byte of 's2' ('pstr_cat') overwrites the null byte at the
N* end of 's1' ('pstr_dest')."
N* (B) "(a null byte and bytes that follow it are not appended)."
N* (C) "A terminating null byte is always appended to the result."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strncat() : RETURN VALUE' states that :
N*
N* (1) "The strncat() function shall return 's1' ('pstr_dest');" ...
N* (2) "no return value shall be reserved to indicate an error."
N* (A) #### This requirement is intentionally NOT implemented in order to return
N* NULL for any error(s).
N*
N* (c) IEEE Std 1003.1, 2004 Edition, Section 'strncat() : DESCRIPTION' states that "if
N* copying takes place between objects that overlap, the behavior is undefined."
N*
N* (3) String concatenation terminates when :
N*
N* (a) Destination/Concatenation string pointer(s) are passed NULL pointers.
N* (1) No string concatenation performed; NULL pointer returned.
N*
N* (b) Destination/Concatenation string pointer(s) point to NULL.
N* (1) String buffer(s) overlap with NULL address; NULL pointer returned.
N*
N* (c) Concatenation string's terminating NULL character found.
N* (1) Entire concatenation string appended to destination string (see Note #2a1A).
N*
N* (d) 'len_max' number of characters concatenated.
N*
N* (1) 'len_max' number of characters does NOT include the terminating NULL character
N* (see Note #2a2).
N*
N* (2) Null concatenations allowed (i.e. zero-length concatenations).
N* (A) No string concatenation performed; destination string returned
N* (see Note #2b1).
N*********************************************************************************************************
N*/
N/*$PAGE*/
NCPU_CHAR *Str_Cat_N ( CPU_CHAR *pstr_dest,
N const CPU_CHAR *pstr_cat,
N CPU_SIZE_T len_max)
N{
N CPU_CHAR *pstr_cat_dest;
N const CPU_CHAR *pstr_cat_src;
N CPU_SIZE_T len_cat;
N
N /* Rtn NULL if str ptr(s) NULL (see Note #3a1). */
N if (pstr_dest == (CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N if (pstr_cat == (const CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N
N if (len_max < 1) { /* Rtn dest str if cat len = 0 (see Note #3d2A). */
N return ((CPU_CHAR *)pstr_dest);
N }
N
N
N pstr_cat_dest = pstr_dest;
N while (( pstr_cat_dest != (CPU_CHAR *) 0 ) && /* Adv to end of cur dest str until NULL ptr ... */
N (*pstr_cat_dest != (CPU_CHAR )'\0')) { /* ... or NULL char found.. */
N pstr_cat_dest++;
N }
N if (pstr_cat_dest == (CPU_CHAR *)0) { /* Rtn NULL if NULL ptr found (see Note #3b1). */
N return ((CPU_CHAR *)0);
N }
N
N pstr_cat_src = pstr_cat;
N len_cat = 0u;
N
N while (( pstr_cat_dest != ( CPU_CHAR *) 0 ) && /* Cat str until NULL ptr(s) [see Note #3b] ... */
N ( pstr_cat_src != (const CPU_CHAR *) 0 ) &&
N (*pstr_cat_src != ( CPU_CHAR )'\0') && /* ... or NULL char found (see Note #3c); ... */
N ( len_cat < ( CPU_SIZE_T)len_max)) { /* ... or max nbr chars cat'd (see Note #3d). */
N *pstr_cat_dest = *pstr_cat_src;
N pstr_cat_dest++;
N pstr_cat_src++;
N len_cat++;
N }
N /* Rtn NULL if NULL ptr(s) found (see Note #3b1). */
N if ((pstr_cat_dest == ( CPU_CHAR *)0) ||
N (pstr_cat_src == (const CPU_CHAR *)0)) {
N return ((CPU_CHAR *)0);
N }
N
N *pstr_cat_dest = (CPU_CHAR)'\0'; /* Append NULL char (see Note #2a2C). */
N
N
N return (pstr_dest); /* Rtn ptr to dest str (see Note #2b1). */
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Cmp()
N*
N* Description : Determine if two strings are identical.
N*
N* Argument(s) : p1_str Pointer to first string (see Note #1).
N*
N* p2_str Pointer to second string (see Note #1).
N*
N* Return(s) : 0, if strings are identical (see Notes #3a1A, #3a2A, & #3b).
N*
N* Negative value, if 'p1_str' is less than 'p2_str' (see Notes #3a1B1, #3a2B1, & #3c).
N*
N* Positive value, if 'p1_str' is greater than 'p2_str' (see Notes #3a1B2, #3a2B2, & #3c).
N*
N* See also Note #2b.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffers NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strcmp() : DESCRIPTION' states that "the
N* strcmp() function shall compare the string pointed to by 's1' ('p1_str') to the
N* string pointed to by 's2' ('p2_str)".
N*
N* (b) (1) IEEE Std 1003.1, 2004 Edition, Section 'strcmp() : RETURN VALUE' states that
N* "upon successful completion, strcmp() shall return an integer greater than,
N* equal to, or less than 0".
N*
N* (2) IEEE Std 1003.1, 2004 Edition, Section 'strcmp() : DESCRIPTION' adds that "the
N* sign of a non-zero return value shall be determined by the sign of the difference
N* between the values of the first pair of bytes ... that differ in the strings
N* being compared".
N*
N* (3) String comparison terminates when :
N*
N* (a) (1) (A) BOTH string pointer(s) are passed NULL pointers.
N* (1) NULL strings identical; 0 returned.
N*
N* (B) (1) 'p1_str' passed a NULL pointer.
N* (a) Return negative value of character pointed to by 'p2_str'.
N*
N* (2) 'p2_str' passed a NULL pointer.
N* (a) Return positive value of character pointed to by 'p1_str'.
N*
N* (2) (A) BOTH strings point to NULL.
N* (1) Strings overlap with NULL address.
N* (2) Strings identical up to but NOT beyond or including the NULL address;
N* 0 returned.
N*
N* (B) (1) 'p1_str_cmp_next' points to NULL.
N* (a) 'p1_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return negative value of character pointed to by 'p2_str_cmp_next'.
N*
N* (2) 'p2_str_cmp_next' points to NULL.
N* (a) 'p2_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return positive value of character pointed to by 'p1_str_cmp_next'.
N*
N* (b) Terminating NULL character found in both strings.
N* (1) Strings identical; 0 returned.
N* (2) Only one NULL character test required in conditional since previous condition
N* tested character equality.
N*
N* (c) Non-matching characters found.
N* (1) Return signed-integer difference of the character pointed to by 'p2_str'
N* from the character pointed to by 'p1_str'.
N*
N* (4) Since 16-bit signed arithmetic is performed to calculate a non-identical comparison
N* return value, 'CPU_CHAR' native data type size MUST be 8-bit.
N*********************************************************************************************************
N*/
N
NCPU_INT16S Str_Cmp (const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str)
N{
N CPU_INT16S cmp_val;
N
N
N cmp_val = Str_Cmp_N(p1_str,
N p2_str,
N DEF_INT_CPU_U_MAX_VAL);
X 4294967295u);
N
N return (cmp_val);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Cmp_N()
N*
N* Description : Determine if two strings are identical for up to a maximum number of characters.
N*
N* Argument(s) : p1_str Pointer to first string (see Note #1).
N*
N* p2_str Pointer to second string (see Note #1).
N*
N* len_max Maximum number of characters to compare (see Note #3d).
N*
N* Return(s) : 0, if strings are identical (see Notes #3a1A, #3a2A, #3b, & #3d).
N*
N* Negative value, if 'p1_str' is less than 'p2_str' (see Notes #3a1B1, #3a2B1, & #3c).
N*
N* Positive value, if 'p1_str' is greater than 'p2_str' (see Notes #3a1B2, #3a2B2, & #3c).
N*
N* See also Note #2b.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffers NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strncmp() : DESCRIPTION' states that :
N*
N* (1) "The strncmp() function shall compare ... the array pointed to by 's1' ('p1_str')
N* to the array pointed to by 's2' ('p2_str)" ...
N* (2) but "not more than 'n' ('len_max') bytes" of either array.
N*
N* (b) (1) IEEE Std 1003.1, 2004 Edition, Section 'strncmp() : RETURN VALUE' states that
N* "upon successful completion, strncmp() shall return an integer greater than,
N* equal to, or less than 0".
N*
N* (2) IEEE Std 1003.1, 2004 Edition, Section 'strncmp() : DESCRIPTION' adds that
N* "the sign of a non-zero return value is determined by the sign of the difference
N* between the values of the first pair of bytes ... that differ in the strings
N* being compared".
N*
N* (3) String comparison terminates when :
N*
N* (a) (1) (A) BOTH string pointer(s) are passed NULL pointers.
N* (1) NULL strings identical; 0 returned.
N*
N* (B) (1) 'p1_str' passed a NULL pointer.
N* (a) Return negative value of character pointed to by 'p2_str'.
N*
N* (2) 'p2_str' passed a NULL pointer.
N* (a) Return positive value of character pointed to by 'p1_str'.
N*
N* (2) (A) BOTH strings point to NULL.
N* (1) Strings overlap with NULL address.
N* (2) Strings identical up to but NOT beyond or including the NULL address;
N* 0 returned.
N*
N* (B) (1) 'p1_str_cmp_next' points to NULL.
N* (a) 'p1_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return negative value of character pointed to by 'p2_str_cmp_next'.
N*
N* (2) 'p2_str_cmp_next' points to NULL.
N* (a) 'p2_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return positive value of character pointed to by 'p1_str_cmp_next'.
N*
N* (b) Terminating NULL character found in both strings.
N* (1) Strings identical; 0 returned.
N* (2) Only one NULL character test required in conditional since previous condition
N* tested character equality.
N*
N* (c) Non-matching characters found.
N* (1) Return signed-integer difference of the character pointed to by 'p2_str'
N* from the character pointed to by 'p1_str'.
N*
N* (d) (1) 'len_max' passed a zero length.
N* (A) Zero-length strings identical; 0 returned.
N*
N* (2) First 'len_max' number of characters identical.
N* (A) Strings identical; 0 returned.
N*
N* See also Note #2a2.
N*
N* (4) Since 16-bit signed arithmetic is performed to calculate a non-identical comparison
N* return value, 'CPU_CHAR' native data type size MUST be 8-bit.
N*********************************************************************************************************
N*/
N/*$PAGE*/
NCPU_INT16S Str_Cmp_N (const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str,
N CPU_SIZE_T len_max)
N{
N const CPU_CHAR *p1_str_cmp;
N const CPU_CHAR *p2_str_cmp;
N const CPU_CHAR *p1_str_cmp_next;
N const CPU_CHAR *p2_str_cmp_next;
N CPU_INT16S cmp_val;
N CPU_SIZE_T cmp_len;
N
N
N if (len_max < 1) { /* If cmp len = 0, rtn 0 (see Note #3d1A). */
N return (0);
N }
N
N if (p1_str == (const CPU_CHAR *)0) {
N if (p2_str == (const CPU_CHAR *)0) {
N return (0); /* If BOTH str ptrs NULL, rtn 0 (see Note #3a1A). */
N }
N cmp_val = (CPU_INT16S)0 - (CPU_INT16S)(*p2_str);
N return (cmp_val); /* If p1_str NULL, rtn neg p2_str val (see Note #3a1B1).*/
N }
N if (p2_str == (const CPU_CHAR *)0) {
N cmp_val = (CPU_INT16S)(*p1_str);
N return (cmp_val); /* If p2_str NULL, rtn pos p1_str val (see Note #3a1B2).*/
N }
N
N
N p1_str_cmp = p1_str;
N p2_str_cmp = p2_str;
N p1_str_cmp_next = p1_str_cmp;
N p2_str_cmp_next = p2_str_cmp;
N p1_str_cmp_next++;
N p2_str_cmp_next++;
N cmp_len = 0u;
N
N while ((*p1_str_cmp == *p2_str_cmp) && /* Cmp strs until non-matching chars (see Note #3c) ... */
N (*p1_str_cmp != ( CPU_CHAR )'\0') && /* ... or NULL chars (see Note #3b) ... */
N ( p1_str_cmp_next != (const CPU_CHAR *) 0 ) && /* ... or NULL ptr(s) found (see Note #3a2). */
N ( p2_str_cmp_next != (const CPU_CHAR *) 0 ) &&
N ( cmp_len < ( CPU_SIZE_T)len_max)) { /* ... or max nbr chars cmp'd (see Note #3d2). */
N p1_str_cmp++;
N p2_str_cmp++;
N p1_str_cmp_next++;
N p2_str_cmp_next++;
N cmp_len++;
N }
N
N
N if (cmp_len == len_max) { /* If strs identical for max len nbr of chars, ... */
N return (0); /* ... rtn 0 (see Note #3d2A). */
N }
N
N if (*p1_str_cmp != *p2_str_cmp) { /* If strs NOT identical, ... */
N /* ... calc & rtn char diff (see Note #3c1). */
N cmp_val = (CPU_INT16S)(*p1_str_cmp) - (CPU_INT16S)(*p2_str_cmp);
N
N } else if (*p1_str_cmp == (CPU_CHAR)'\0') { /* If NULL char(s) found, ... */
N cmp_val = (CPU_INT16S)0; /* ... strs identical; rtn 0 (see Note #3b). */
N
N } else {
N if (p1_str_cmp_next == (const CPU_CHAR *)0) {
N if (p2_str_cmp_next == (const CPU_CHAR *)0) { /* If BOTH next str ptrs NULL, ... */
N cmp_val = (CPU_INT16S)0; /* ... rtn 0 (see Note #3a2A). */
N } else { /* If p1_str_cmp_next NULL, ... */
N /* ... rtn neg p2_str_cmp_next val (see Note #3a2B1). */
N cmp_val = (CPU_INT16S)0 - (CPU_INT16S)(*p2_str_cmp_next);
N }
N } else { /* If p2_str_cmp_next NULL, ... */
N cmp_val = (CPU_INT16S)(*p1_str_cmp_next); /* ... rtn pos p1_str_cmp_next val (see Note #3a2B2). */
N }
N }
N
N
N return (cmp_val);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_CmpIgnoreCase()
N*
N* Description : Determine if two strings are identical, ignoring case.
N*
N* Argument(s) : p1_str Pointer to first string (see Note #1).
N*
N* p2_str Pointer to second string (see Note #1).
N*
N* Return(s) : 0, if strings are identical (see Notes #3a1A, #3a2A, & #3b).
N*
N* Negative value, if 'p1_str' is less than 'p2_str' (see Notes #3a1B1, #3a2B1, & #3c).
N*
N* Positive value, if 'p1_str' is greater than 'p2_str' (see Notes #3a1B2, #3a2B2, & #3c).
N*
N* See also Note #2b.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffers NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strcasecmp() : DESCRIPTION' states that :
N*
N* (1) (A) "The strcasecmp() function shall compare ... the string pointed to by 's1'
N* ('p1_str') to the string pointed to by 's2' ('p2_str')" ...
N* (B) "ignoring differences in case".
N*
N* (2) "strcasecmp() ... shall behave as if the strings had been converted to lowercase
N* and then a byte comparison performed."
N*
N* (b) (1) IEEE Std 1003.1, 2004 Edition, Section 'strcasecmp() : RETURN VALUE' states that
N* "upon successful completion, strcasecmp() shall return an integer greater than,
N* equal to, or less than 0".
N*
N* (2) IEEE Std 1003.1, 2004 Edition, Section 'strcmp() : DESCRIPTION' adds that "the
N* sign of a non-zero return value shall be determined by the sign of the difference
N* between the values of the first pair of bytes ... that differ in the strings
N* being compared".
N*
N* (3) String comparison terminates when :
N*
N* (a) (1) (A) BOTH string pointer(s) are passed NULL pointers.
N* (1) NULL strings identical; 0 returned.
N*
N* (B) (1) 'p1_str' passed a NULL pointer.
N* (a) Return negative value of character pointed to by 'p2_str', converted
N* to lower case (see Note #2a2).
N*
N* (2) 'p2_str' passed a NULL pointer.
N* (a) Return positive value of character pointed to by 'p1_str', converted
N* to lower case (see Note #2a2).
N*
N* (2) (A) BOTH strings point to NULL.
N* (1) Strings overlap with NULL address.
N* (2) Strings identical up to but NOT beyond or including the NULL address;
N* 0 returned.
N*
N* (B) (1) 'p1_str_cmp_next' points to NULL.
N* (a) 'p1_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return negative value of character pointed to by 'p2_str_cmp_next',
N* converted to lower case (see Note #2a2).
N*
N* (2) 'p2_str_cmp_next' points to NULL.
N* (a) 'p2_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return positive value of character pointed to by 'p1_str_cmp_next',
N* converted to lower case (see Note #2a2).
N*
N* (b) Terminating NULL character found in both strings.
N* (1) Strings identical; 0 returned.
N* (2) Only one NULL character test required in conditional since previous condition
N* tested character equality.
N*
N* (c) Non-matching characters found.
N* (1) Return signed-integer difference of the character pointed to by 'p2_str',
N* converted to lower case, from the character pointed to by 'p1_str', converted
N* to lower case.
N*
N* (4) Since 16-bit signed arithmetic is performed to calculate a non-identical comparison
N* return value, 'CPU_CHAR' native data type size MUST be 8-bit.
N*********************************************************************************************************
N*/
N/*$PAGE*/
NCPU_INT16S Str_CmpIgnoreCase (const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str)
N{
N CPU_INT16S cmp_val;
N
N
N cmp_val = Str_CmpIgnoreCase_N(p1_str,
N p2_str,
N DEF_INT_CPU_U_MAX_VAL);
X 4294967295u);
N
N return (cmp_val);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_CmpIgnoreCase_N()
N*
N* Description : Determine if two strings are identical for up to a maximum number of characters,
N* ignoring case.
N*
N* Argument(s) : p1_str Pointer to first string (see Note #1).
N*
N* p2_str Pointer to second string (see Note #1).
N*
N* len_max Maximum number of characters to compare (see Note #3d).
N*
N* Return(s) : 0, if strings are identical (see Notes #3a1A, #3a2A, #3b, & #3d).
N*
N* Negative value, if 'p1_str' is less than 'p2_str' (see Notes #3a1B1, #3a2B1, & #3c).
N*
N* Positive value, if 'p1_str' is greater than 'p2_str' (see Notes #3a1B2, #3a2B2, & #3c).
N*
N* See also Note #2b.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffers NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strncasecmp() : DESCRIPTION' states that :
N*
N* (1) (A) "The strncasecmp() function shall compare ... the string pointed to by 's1'
N* ('p1_str') to the string pointed to by 's2' ('p2_str')" ...
N* (B) "ignoring differences in case" ...
N* (C) but "not more than 'n' ('len_max') bytes" of either string.
N*
N* (2) "strncasecmp() shall behave as if the strings had been converted to lowercase
N* and then a byte comparison performed."
N*
N* (b) (1) IEEE Std 1003.1, 2004 Edition, Section 'strncasecmp() : RETURN VALUE' states that
N* "upon successful completion, strncasecmp() shall return an integer greater than,
N* equal to, or less than 0".
N*
N* (2) IEEE Std 1003.1, 2004 Edition, Section 'strcmp() : DESCRIPTION' adds that "the
N* sign of a non-zero return value shall be determined by the sign of the difference
N* between the values of the first pair of bytes ... that differ in the strings
N* being compared".
N*
N* (3) String comparison terminates when :
N*
N* (a) (1) (A) BOTH string pointer(s) are passed NULL pointers.
N* (1) NULL strings identical; 0 returned.
N*
N* (B) (1) 'p1_str' passed a NULL pointer.
N* (a) Return negative value of character pointed to by 'p2_str', converted
N* to lower case (see Note #2a2).
N*
N* (2) 'p2_str' passed a NULL pointer.
N* (a) Return positive value of character pointed to by 'p1_str', converted
N* to lower case (see Note #2a2).
N*
N* (2) (A) BOTH strings point to NULL.
N* (1) Strings overlap with NULL address.
N* (2) Strings identical up to but NOT beyond or including the NULL address;
N* 0 returned.
N*
N* (B) (1) 'p1_str_cmp_next' points to NULL.
N* (a) 'p1_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return negative value of character pointed to by 'p2_str_cmp_next',
N* converted to lower case (see Note #2a2).
N*
N* (2) 'p2_str_cmp_next' points to NULL.
N* (a) 'p2_str' overlaps with NULL address.
N* (b) Strings compared up to but NOT beyond or including the NULL address.
N* (c) Return positive value of character pointed to by 'p1_str_cmp_next',
N* converted to lower case (see Note #2a2).
N*
N* (b) Terminating NULL character found in both strings.
N* (1) Strings identical; 0 returned.
N* (2) Only one NULL character test required in conditional since previous condition
N* tested character equality.
N*
N* (c) Non-matching characters found.
N* (1) Return signed-integer difference of the character pointed to by 'p2_str',
N* converted to lower case, from the character pointed to by 'p1_str', converted
N* to lower case.
N*
N* (d) (1) 'len_max' passed a zero length.
N* (A) Zero-length strings identical; 0 returned.
N*
N* (2) First 'len_max' number of characters identical.
N* (A) Strings identical; 0 returned.
N*
N* See also Note #2a1C.
N*$PAGE*
N* (4) Since 16-bit signed arithmetic is performed to calculate a non-identical comparison
N* return value, 'CPU_CHAR' native data type size MUST be 8-bit.
N*********************************************************************************************************
N*/
N
NCPU_INT16S Str_CmpIgnoreCase_N (const CPU_CHAR *p1_str,
N const CPU_CHAR *p2_str,
N CPU_SIZE_T len_max)
N{
N const CPU_CHAR *p1_str_cmp;
N const CPU_CHAR *p2_str_cmp;
N const CPU_CHAR *p1_str_cmp_next;
N const CPU_CHAR *p2_str_cmp_next;
N CPU_CHAR char_1;
N CPU_CHAR char_2;
N CPU_INT16S cmp_val;
N CPU_SIZE_T cmp_len;
N
N
N if (len_max < 1) { /* If cmp len = 0, rtn 0 (see Note #3d1A). */
N return (0);
N }
N
N if (p1_str == (const CPU_CHAR *)0) {
N if (p2_str == (const CPU_CHAR *)0) {
N return (0); /* If BOTH str ptrs NULL, rtn 0 (see Note #3a1A). */
N }
N char_2 = ASCII_ToLower(*p2_str);
N cmp_val = (CPU_INT16S)0 - (CPU_INT16S)char_2;
N return (cmp_val); /* If p1_str NULL, rtn neg p2_str val (see Note #3a1B1).*/
N }
N if (p2_str == (const CPU_CHAR *)0) {
N char_1 = ASCII_ToLower(*p1_str);
N cmp_val = (CPU_INT16S)char_1;
N return (cmp_val); /* If p2_str NULL, rtn pos p1_str val (see Note #3a1B2).*/
N }
N
N
N p1_str_cmp = p1_str;
N p2_str_cmp = p2_str;
N p1_str_cmp_next = p1_str_cmp;
N p2_str_cmp_next = p2_str_cmp;
N p1_str_cmp_next++;
N p2_str_cmp_next++;
N char_1 = ASCII_ToLower(*p1_str_cmp);
N char_2 = ASCII_ToLower(*p2_str_cmp);
N cmp_len = 0u;
N
N while (( char_1 == char_2) && /* Cmp strs until non-matching chars (see Note #3c) ... */
N (*p1_str_cmp != ( CPU_CHAR )'\0') && /* ... or NULL chars (see Note #3b) ... */
N ( p1_str_cmp_next != (const CPU_CHAR *) 0 ) && /* ... or NULL ptr(s) found (see Note #3a2). */
N ( p2_str_cmp_next != (const CPU_CHAR *) 0 ) &&
N ( cmp_len < ( CPU_SIZE_T)len_max)) { /* ... or max nbr chars cmp'd (see Note #3d2). */
N p1_str_cmp++;
N p2_str_cmp++;
N p1_str_cmp_next++;
N p2_str_cmp_next++;
N cmp_len++;
N char_1 = ASCII_ToLower(*p1_str_cmp);
N char_2 = ASCII_ToLower(*p2_str_cmp);
N }
N
N
N if (cmp_len == len_max) { /* If strs identical for max len nbr of chars, ... */
N return (0); /* ... rtn 0 (see Note #3d2A). */
N }
N
N if (char_1 != char_2) { /* If strs NOT identical, ... */
N cmp_val = (CPU_INT16S)char_1 - (CPU_INT16S)char_2; /* ... calc & rtn char diff (see Note #3c1). */
N
N } else if (char_1 == (CPU_CHAR)'\0') { /* If NULL char(s) found, ... */
N cmp_val = (CPU_INT16S)0; /* ... strs identical; rtn 0 (see Note #3b). */
N
N } else {
N if (p1_str_cmp_next == (const CPU_CHAR *)0) {
N if (p2_str_cmp_next == (const CPU_CHAR *)0) { /* If BOTH next str ptrs NULL, ... */
N cmp_val = (CPU_INT16S)0; /* ... rtn 0 (see Note #3a2A). */
N } else { /* If p1_str_cmp_next NULL, ... */
N char_2 = ASCII_ToLower(*p2_str_cmp_next);
N cmp_val = (CPU_INT16S)0 - (CPU_INT16S)char_2; /* ... rtn neg p2_str_cmp_next val (see Note #3a2B1). */
N }
N } else { /* If p2_str_cmp_next NULL, ... */
N char_1 = ASCII_ToLower(*p1_str_cmp_next);
N cmp_val = (CPU_INT16S)char_1; /* ... rtn pos p1_str_cmp_next val (see Note #3a2B2). */
N }
N }
N
N
N return (cmp_val);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Char()
N*
N* Description : Search string for first occurrence of specific character.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* srch_char Search character.
N*
N* Return(s) : Pointer to first occurrence of search character in string, if any (see Note #2b1).
N*
N* Pointer to NULL, otherwise (see Note #2b2).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strchr() : DESCRIPTION' states that :
N*
N* (1) "The strchr() function shall locate the first occurrence of 'c' ('srch_char')
N* ... in the string pointed to by 's' ('pstr')."
N* (2) "The terminating null byte is considered to be part of the string."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strchr() : RETURN VALUE' states that
N* "upon completion, strchr() shall return" :
N*
N* (1) "a pointer to the byte," ...
N* (2) "or a null pointer if the byte was not found."
N* (A) #### Although NO strchr() specification states to return NULL for
N* any other reason(s), NULL is also returned for any error(s).
N*
N* (3) String search terminates when :
N*
N* (a) String pointer passed a NULL pointer.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer points to NULL.
N* (1) String overlaps with NULL address; NULL pointer returned.
N*
N* (c) String's terminating NULL character found.
N* (1) Search character NOT found in search string; NULL pointer returned
N* (see Note #2b2).
N* (2) Applicable even if search character is the terminating NULL character
N* (see Note #2a2).
N*
N* (d) Search character found.
N* (1) Return pointer to first occurrence of search character in search string
N* (see Note #2a1).
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_Char (const CPU_CHAR *pstr,
N CPU_CHAR srch_char)
N{
N CPU_CHAR *pstr_rtn;
N
N
N pstr_rtn = Str_Char_N(pstr,
N DEF_INT_CPU_U_MAX_VAL,
X 4294967295u,
N srch_char);
N
N return (pstr_rtn);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Char_N()
N*
N* Description : Search string for first occurrence of specific character, up to a maximum number
N* of characters.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* len_max Maximum number of characters to search (see Notes #2c & #3e).
N*
N* srch_char Search character.
N*
N* Return(s) : Pointer to first occurrence of search character in string, if any (see Note #2b1).
N*
N* Pointer to NULL, otherwise (see Note #2b2).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strchr() : DESCRIPTION' states that :
N*
N* (1) "The strchr() function shall locate the first occurrence of 'c' ('srch_char')
N* ... in the string pointed to by 's' ('pstr')."
N* (2) "The terminating null byte is considered to be part of the string."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strchr() : RETURN VALUE' states that
N* "upon completion, strchr() shall return" :
N*
N* (1) "a pointer to the byte," ...
N* (2) "or a null pointer if the byte was not found."
N* (A) #### Although NO strchr() specification states to return NULL for
N* any other reason(s), NULL is also returned for any error(s).
N*
N* (c) Ideally, the 'len_max' argument would be the last argument in this function's
N* argument list for consistency with all other custom string library functions.
N* However, the 'len_max' argument is sequentially ordered as the second argument
N* to comply with most standard library's strnchr() argument list.
N*
N* (3) String search terminates when :
N*
N* (a) String pointer passed a NULL pointer.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer points to NULL.
N* (1) String overlaps with NULL address; NULL pointer returned.
N*
N* (c) String's terminating NULL character found.
N* (1) Search character NOT found in search string; NULL pointer returned
N* (see Note #2b2).
N* (2) Applicable even if search character is the terminating NULL character
N* (see Note #2a2).
N*
N* (d) Search character found.
N* (1) Return pointer to first occurrence of search character in search string
N* (see Note #2a1).
N*
N* (e) 'len_max' number of characters searched.
N* (1) Search character NOT found in search string within first 'len_max' number
N* of characters; NULL pointer returned.
N* (2) 'len_max' number of characters MAY include terminating NULL character
N* (see Note #2a2).
N*********************************************************************************************************
N*/
N/*$PAGE*/
NCPU_CHAR *Str_Char_N (const CPU_CHAR *pstr,
N CPU_SIZE_T len_max,
N CPU_CHAR srch_char)
N{
N const CPU_CHAR *pstr_char;
N CPU_SIZE_T len_srch;
N
N
N if (pstr == (const CPU_CHAR *)0) { /* Rtn NULL if srch str ptr NULL (see Note #3a1). */
N return ((CPU_CHAR *)0);
N }
N
N if (len_max < 1) { /* Rtn NULL if srch len = 0 (see Note #3e1). */
N return ((CPU_CHAR *)0);
N }
N
N
N pstr_char = pstr;
N len_srch = 0u;
N
N while (( pstr_char != (const CPU_CHAR *) 0 ) && /* Srch str until NULL ptr [see Note #3b] ... */
N (*pstr_char != ( CPU_CHAR )'\0') && /* ... or NULL char (see Note #3c) ... */
N (*pstr_char != ( CPU_CHAR )srch_char) && /* ... or srch char found (see Note #3d); ... */
N ( len_srch < ( CPU_SIZE_T)len_max)) { /* ... or max nbr chars srch'd (see Note #3e). */
N pstr_char++;
N len_srch++;
N }
N
N
N if (pstr_char == (const CPU_CHAR *)0) { /* Rtn NULL if NULL ptr found (see Note #3b1). */
N return ((CPU_CHAR *)0);
N }
N
N if (len_srch >= len_max) { /* Rtn NULL if srch char NOT found ... */
N return ((CPU_CHAR *)0); /* ... within max nbr of chars (see Note #3e1). */
N }
N
N if (*pstr_char != srch_char) { /* Rtn NULL if srch char NOT found (see Note #3c1). */
N return ((CPU_CHAR *)0);
N }
N
N
N return ((CPU_CHAR *)pstr_char); /* Else rtn ptr to found srch char (see Note #3d1). */
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Char_Last()
N*
N* Description : Search string for last occurrence of specific character.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* srch_char Search character.
N*
N* Return(s) : Pointer to last occurrence of search character in string, if any (see Note #2b1).
N*
N* Pointer to NULL, otherwise (see Note #2b2).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strrchr() : DESCRIPTION' states that :
N*
N* (1) "The strrchr() function shall locate the last occurrence of 'c' ('srch_char')
N* ... in the string pointed to by 's' ('pstr')."
N* (2) "The terminating null byte is considered to be part of the string."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strrchr() : RETURN VALUE' states that
N* "upon successful completion, strrchr() shall return" :
N*
N* (1) "a pointer to the byte" ...
N* (2) "or a null pointer if 'c' ('srch_char') does not occur in the string."
N* (A) #### Although NO strrchr() specification states to return NULL for
N* any other reason(s), NULL is also returned for any error(s).
N*
N* (3) String search terminates when :
N*
N* (a) String pointer passed a NULL pointer.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer points to NULL.
N* (1) String overlaps with NULL address; NULL pointer returned.
N*
N* (c) String searched from end to beginning.
N* (1) Search character NOT found in search string; NULL pointer returned.
N* (2) Applicable even if search character is the terminating NULL character
N* (see Note #2a2).
N*
N* (d) Search character found.
N* (1) Return pointer to last occurrence of search character in search string
N* (see Note #2a1).
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_Char_Last (const CPU_CHAR *pstr,
N CPU_CHAR srch_char)
N{
N CPU_CHAR *pstr_rtn;
N
N
N pstr_rtn = Str_Char_Last_N(pstr,
N DEF_INT_CPU_U_MAX_VAL,
X 4294967295u,
N srch_char);
N
N return (pstr_rtn);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Char_Last_N()
N*
N* Description : Search string for last occurrence of specific character, up to a maximum number
N* of characters.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* len_max Maximum number of characters to search (see Notes #2c & #3e).
N*
N* srch_char Search character.
N*
N* Return(s) : Pointer to last occurrence of search character in string, if any (see Note #2b1).
N*
N* Pointer to NULL, otherwise (see Note #2b2).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strrchr() : DESCRIPTION' states that :
N*
N* (1) "The strrchr() function shall locate the last occurrence of 'c' ('srch_char')
N* ... in the string pointed to by 's' ('pstr')."
N* (2) "The terminating null byte is considered to be part of the string."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strrchr() : RETURN VALUE' states that
N* "upon successful completion, strrchr() shall return" :
N*
N* (1) "a pointer to the byte" ...
N* (2) "or a null pointer if 'c' ('srch_char') does not occur in the string."
N* (A) #### Although NO strrchr() specification states to return NULL for
N* any other reason(s), NULL is also returned for any error(s).
N*
N* (c) Ideally, the 'len_max' argument would be the last argument in this function's
N* argument list for consistency with all other custom string library functions.
N* However, the 'len_max' argument is sequentially ordered as the second argument
N* to comply with most standard library's strnrchr() argument list.
N*
N* See also 'Str_Char_N() Note #2c'.
N*
N* (3) String search terminates when :
N*
N* (a) String pointer passed a NULL pointer.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer points to NULL.
N* (1) String overlaps with NULL address; NULL pointer returned.
N*
N* (c) String searched from end to beginning.
N* (1) Search character NOT found in search string; NULL pointer returned
N* (see Note #2b2).
N* (2) Applicable even if search character is the terminating NULL character
N* (see Note #2a2).
N*
N* (d) Search character found.
N* (1) Return pointer to last occurrence of search character in search string
N* (see Note #2a1).
N*
N* (e) 'len_max' number of characters searched.
N* (1) Search character NOT found in search string within last 'len_max' number
N* of characters; NULL pointer returned.
N* (2) 'len_max' number of characters MAY include terminating NULL character
N* (see Note #2a2).
N*********************************************************************************************************
N*/
N/*$PAGE*/
NCPU_CHAR *Str_Char_Last_N (const CPU_CHAR *pstr,
N CPU_SIZE_T len_max,
N CPU_CHAR srch_char)
N{
N const CPU_CHAR *pstr_char;
N CPU_SIZE_T str_len_max;
N CPU_SIZE_T str_len;
N
N
N if (pstr == (const CPU_CHAR *)0) { /* Rtn NULL if srch str ptr NULL (see Note #3a1). */
N return ((CPU_CHAR *)0);
N }
N
N if (len_max < 1) { /* Rtn NULL if srch len = 0 (see Note #3e1). */
N return ((CPU_CHAR *)0);
N }
N
N
N pstr_char = pstr;
N str_len_max = len_max - sizeof((CPU_CHAR)'\0'); /* Str len adj'd for NULL char len. */
N str_len = Str_Len_N(pstr_char, str_len_max);
N pstr_char += str_len;
N
N if (pstr_char == (const CPU_CHAR *)0) { /* Rtn NULL if NULL ptr found (see Note #3b1). */
N return ((CPU_CHAR *)0);
N }
N
N while (( pstr_char != pstr) && /* Srch str from end until beginning (see Note #3c) ... */
N (*pstr_char != srch_char)) { /* ... until srch char found (see Note #3d). */
N pstr_char--;
N }
N
N
N if (*pstr_char != srch_char) { /* Rtn NULL if srch char NOT found (see Note #3c1). */
N return ((CPU_CHAR *)0);
N }
N
N
N return ((CPU_CHAR *)pstr_char); /* Else rtn ptr to found srch char (see Note #3d1). */
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Char_Replace()
N*
N* Description : Search string for specific character and replace it by another specific character.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* char_srch Search character.
N*
N* char_replace Replace character.
N*
N* Return(s) : Pointer to string, if NO error(s).
N*
N* Pointer to NULL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer modified.
N*
N* (2) String search terminates when :
N*
N* (a) String pointer passed a NULL pointer.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer points to NULL.
N* (1) String overlaps with NULL address; NULL pointer returned.
N*
N* (c) String's terminating NULL character found.
N* (1) Search character NOT found in search string; NULL pointer returned
N* (2) Applicable even if search character is the terminating NULL character
N*
N* (d) Search character found.
N* (1) Replace character found by the specified character.
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_Char_Replace (CPU_CHAR *pstr,
N CPU_CHAR char_srch,
N CPU_CHAR char_replace)
N{
N CPU_CHAR *pstr_rtn;
N
N
N pstr_rtn = Str_Char_Replace_N(pstr,
N char_srch,
N char_replace,
N DEF_INT_CPU_U_MAX_VAL);
X 4294967295u);
N
N return (pstr_rtn);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Char_Replace_N()
N*
N* Description : Search string for specific character and replace it by another specific character, up to
N* a maximum number of characters.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* char_srch Search character.
N*
N* char_replace Replace character.
N*
N* len_max Maximum number of characters to search (see Notes #2c & #3e).
N*
N* Return(s) : Pointer to string, if NO error(s).
N*
N* Pointer to NULL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer modified.
N*
N* (2) String search terminates when :
N*
N* (a) String pointer passed a NULL pointer.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer points to NULL.
N* (1) String overlaps with NULL address; NULL pointer returned.
N*
N* (c) String's terminating NULL character found.
N* (1) Search character NOT found in search string; NULL pointer returned
N* (2) Applicable even if search character is the terminating NULL character
N*
N* (d) Search character found.
N* (1) Replace character found by the specified character.
N*
N* (e) 'len_max' number of characters searched.
N* (1) Search character NOT found in search string within first 'len_max' number
N* of characters; NULL pointer returned.
N* (2) 'len_max' number of characters MAY include terminating NULL character
N* (see Note #2a2).
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_Char_Replace_N (CPU_CHAR *pstr,
N CPU_CHAR char_srch,
N CPU_CHAR char_replace,
N CPU_SIZE_T len_max)
N{
N CPU_CHAR *pstr_char;
N CPU_SIZE_T len;
N
N
N if (pstr == (const CPU_CHAR *)0) { /* Rtn NULL if srch str ptr NULL (see Note #2a1). */
N return ((CPU_CHAR *)0);
N }
N
N if (len_max < 1) { /* Rtn NULL if srch len = 0 (see Note #2e1). */
N return ((CPU_CHAR *)0);
N }
N
N pstr_char = pstr;
N len = len_max;
N
N while (( pstr_char != (const CPU_CHAR *)0) && /* Srch str until NULL ptr [see Note #2b] ... */
N (*pstr_char != ASCII_CHAR_NULL ) && /* ... or NULL char (see Note #2c) ... */
X (*pstr_char != 0x00 ) &&
N ( len > 0)) { /* ... or max nbr chars srch'd (see Note #2e). */
N
N if (*pstr_char == char_srch) {
N *pstr_char = char_replace; /* Replace char if srch char is found. */
N }
N
N pstr_char++;
N len--;
N }
N
N return (pstr);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Str()
N*
N* Description : Search string for first occurence of a specific search string.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* pstr_srch Pointer to search string (see Note #1).
N*
N* Return(s) : Pointer to first occurrence of search string in string, if any (see Note #2b1A).
N*
N* Pointer to string, if NULL search string (see Note #2b2).
N*
N* Pointer to NULL, otherwise (see Note #2b1B).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffers NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strstr() : DESCRIPTION' states that :
N*
N* (1) "The strstr() function shall locate the first occurrence in the string
N* pointed to by 's1' ('pstr') of the sequence of bytes ... in the string
N* pointed to by 's2' ('pstr_srch')" ...
N* (2) "(excluding the terminating null byte)."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strstr() : RETURN VALUE' states that :
N*
N* (1) "Upon successful completion, strstr() shall return" :
N* (A) "a pointer to the located string" ...
N* (B) "or a null pointer if the string is not found."
N* (1) #### Although NO strstr() specification states to return NULL for
N* any other reason(s), NULL is also returned for any error(s).
N*
N* (2) "If 's2' ('pstr_srch') points to a string with zero length, the function
N* shall return 's1' ('pstr')."
N*
N* (3) String search terminates when :
N*
N* (a) String pointer(s) are passed NULL pointers.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer(s) point to NULL.
N* (1) String buffer(s) overlap with NULL address; NULL pointer returned.
N*
N* (c) Search string length equal to zero.
N* (1) No string search performed; string pointer returned (see Note #2b2).
N*
N* (d) Search string length greater than string length.
N* (1) No string search performed; NULL pointer returned (see Note #2b1B).
N*
N* (e) Entire string has been searched.
N* (1) Search string not found; NULL pointer returned (see Note #2b1B).
N*
N* (f) Search string found.
N* (1) Return pointer to first occurrence of search string in string (see Note #2b1A).
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_Str (const CPU_CHAR *pstr,
N const CPU_CHAR *pstr_srch)
N{
N CPU_CHAR *pstr_rtn;
N
N
N pstr_rtn = Str_Str_N(pstr,
N pstr_srch,
N DEF_INT_CPU_U_MAX_VAL);
X 4294967295u);
N
N return (pstr_rtn);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_Str_N()
N*
N* Description : Search string for first occurence of a specific search string, up to a maximum number
N* of characters.
N*
N* Argument(s) : pstr Pointer to string (see Note #1).
N*
N* pstr_srch Pointer to search string (see Note #1).
N*
N* len_max Maximum number of characters to search (see Note #3g).
N*
N* Return(s) : Pointer to first occurrence of search string in string, if any (see Note #2b1A).
N*
N* Pointer to string, if NULL search string (see Note #2b2).
N*
N* Pointer to NULL, otherwise (see Note #2b1B).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffers NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strstr() : DESCRIPTION' states that :
N*
N* (1) "The strstr() function shall locate the first occurrence in the string
N* pointed to by 's1' ('pstr') of the sequence of bytes ... in the string
N* pointed to by 's2' ('pstr_srch')" ...
N* (2) "(excluding the terminating null byte)."
N*
N* (b) IEEE Std 1003.1, 2004 Edition, Section 'strstr() : RETURN VALUE' states that :
N*
N* (1) "Upon successful completion, strstr() shall return" :
N* (A) "a pointer to the located string" ...
N* (B) "or a null pointer if the string is not found."
N* (1) #### Although NO strstr() specification states to return NULL for
N* any other reason(s), NULL is also returned for any error(s).
N*
N* (2) "If 's2' ('pstr_srch') points to a string with zero length, the function
N* shall return 's1' ('pstr')."
N*
N* (3) String search terminates when :
N*
N* (a) String pointer(s) are passed NULL pointers.
N* (1) No string search performed; NULL pointer returned.
N*
N* (b) String pointer(s) point to NULL.
N* (1) String buffer(s) overlap with NULL address; NULL pointer returned.
N*
N* (c) Search string length equal to zero.
N* (1) No string search performed; string pointer returned (see Note #2b2).
N*
N* (d) Search string length greater than string length.
N* (1) No string search performed; NULL pointer returned (see Note #2b1B).
N*
N* (e) Entire string has been searched.
N* (1) Search string not found; NULL pointer returned (see Note #2b1B).
N* (2) Maximum size of the search is defined as the subtraction of the
N* search string length from the string length.
N*
N* (f) Search string found.
N* (1) Return pointer to first occurrence of search string in string (see Note #2b1A).
N* (2) Search string found via Str_Cmp_N().
N*
N* (g) 'len_max' number of characters searched.
N* (1) 'len_max' number of characters does NOT include terminating NULL character
N* (see Note #2a2).
N*********************************************************************************************************
N*/
N/*$PAGE*/
NCPU_CHAR *Str_Str_N (const CPU_CHAR *pstr,
N const CPU_CHAR *pstr_srch,
N CPU_SIZE_T len_max)
N{
N CPU_SIZE_T str_len;
N CPU_SIZE_T str_len_srch;
N CPU_SIZE_T len_max_srch;
N CPU_SIZE_T srch_len;
N CPU_SIZE_T srch_ix;
N CPU_BOOLEAN srch_done;
N CPU_INT16S srch_cmp;
N const CPU_CHAR *pstr_str;
N const CPU_CHAR *pstr_srch_ix;
N
N /* Rtn NULL if str ptr(s) NULL (see Note #3a). */
N if (pstr == (const CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N if (pstr_srch == (const CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N
N if (len_max < 1) { /* Rtn NULL if srch len = 0 (see Note #3g). */
N return ((CPU_CHAR *)0);
N }
N
N /* Lim max srch str len (to chk > str len). */
N len_max_srch = (len_max < DEF_INT_CPU_U_MAX_VAL)
X len_max_srch = (len_max < 4294967295u)
N ? (len_max + 1u) : DEF_INT_CPU_U_MAX_VAL;
X ? (len_max + 1u) : 4294967295u;
N
N str_len = Str_Len_N(pstr, len_max);
N str_len_srch = Str_Len_N(pstr_srch, len_max_srch);
N if (str_len_srch < 1) { /* Rtn ptr to str if srch str len = 0 (see Note #2b2). */
N return ((CPU_CHAR *)pstr);
N }
N if (str_len_srch > str_len) { /* Rtn NULL if srch str len > str len (see Note #3d). */
N return ((CPU_CHAR *)0);
N }
N /* Rtn NULL if NULL ptr found (see Note #3b1). */
N pstr_str = pstr + str_len;
N if (pstr_str == (const CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N pstr_str = pstr_srch + str_len_srch;
N if (pstr_str == (const CPU_CHAR *)0) {
N return ((CPU_CHAR *)0);
N }
N
N
N srch_len = str_len - str_len_srch; /* Calc srch len (see Note #3e2). */
N srch_ix = 0u;
N srch_done = DEF_NO;
X srch_done = 0u;
N
N do {
N pstr_srch_ix = (const CPU_CHAR *)(pstr + srch_ix);
N srch_cmp = Str_Cmp_N(pstr_srch_ix, pstr_srch, str_len_srch);
N srch_done = (srch_cmp == 0) ? DEF_YES : DEF_NO;
X srch_done = (srch_cmp == 0) ? 1u : 0u;
N srch_ix++;
N } while ((srch_done == DEF_NO) && (srch_ix <= srch_len));
X } while ((srch_done == 0u) && (srch_ix <= srch_len));
N
N
N if (srch_cmp != 0) { /* Rtn NULL if srch str NOT found (see Note #3e2). */
N return ((CPU_CHAR *)0);
N }
N
N return ((CPU_CHAR *)pstr_srch_ix); /* Else rtn ptr to found srch str (see Note #3f1). */
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_FmtNbr_Int32U()
N*
N* Description : Format 32-bit unsigned integer into a multi-digit character string.
N*
N* Argument(s) : nbr Number to format.
N*
N* nbr_dig Number of digits to format (see Note #1).
N*
N* The following may be used to specify the number of digits to format :
N*
N* DEF_INT_32U_NBR_DIG_MIN Minimum number of 32-bit unsigned digits
N* DEF_INT_32U_NBR_DIG_MAX Maximum number of 32-bit unsigned digits
N*
N* nbr_base Base of number to format (see Note #2).
N*
N* The following may be used to specify the number base :
N*
N* DEF_NBR_BASE_BIN Base 2
N* DEF_NBR_BASE_OCT Base 8
N* DEF_NBR_BASE_DEC Base 10
N* DEF_NBR_BASE_HEX Base 16
N*
N* lead_char Prepend leading character (see Note #3) :
N*
N* '\0' Do NOT prepend leading character to string.
N* Printable character Prepend leading character to string.
N* Unprintable character Format invalid string (see Note #6).
N*
N* lower_case Format alphabetic characters (if any) in lower case :
N*
N* DEF_NO Format alphabetic characters in upper case.
N* DEF_YES Format alphabetic characters in lower case.
N*
N* nul Append terminating NULL-character (see Note #4) :
N*
N* DEF_NO Do NOT append terminating NULL-character to string.
N* DEF_YES Append terminating NULL-character to string.
N*
N* pstr Pointer to character array to return formatted number string (see Note #5).
N*
N* Return(s) : Pointer to formatted string, if NO error(s).
N*
N* Pointer to NULL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) If the number of digits to format ('nbr_dig') is zero; then NO formatting
N* is performed except possible NULL-termination of the string (see Note #4).
N*
N* Example :
N*
N* nbr = 23456
N* nbr_dig = 0
N* nbr_base = 10
N*
N* pstr = "" See Note #6a
N*
N* (b) If the number of digits to format ('nbr_dig') is less than the number of
N* significant integer digits of the number to format ('nbr'); then an invalid
N* string is formatted instead of truncating any significant integer digits.
N*
N* Example :
N*
N* nbr = 23456
N* nbr_dig = 3
N* nbr_base = 10
N*
N* pstr = "???" See Note #6b
N*
N* (2) The number's base MUST be between 2 & 36, inclusive.
N*$PAGE*
N* (3) Leading character option prepends leading characters prior to the first non-zero digit.
N*
N* (a) (1) Leading character MUST be a printable ASCII character.
N*
N* (2) (A) Leading character MUST NOT be a number base digit, ...
N* (B) with the exception of '0'.
N*
N* (b) The number of leading characters is such that the total number of significant
N* integer digits plus the number of leading characters is equal to the requested
N* number of integer digits to format ('nbr_dig').
N*
N* Example :
N*
N* nbr = 23456
N* nbr_dig = 7
N* nbr_base = 10
N* lead_char = ' '
N*
N* pstr = " 23456"
N*
N* (c) (1) If the value of the number to format is zero ...
N* (2) ... & the number of digits to format is non-zero, ...
N* (3) ... but NO leading character available; ...
N* (4) ... then one digit of '0' value is formatted.
N*
N* This is NOT a leading character; but a single integer digit of '0' value.
N*
N* (4) (a) NULL-character terminate option DISABLED prevents overwriting previous character
N* array formatting.
N*
N* (b) WARNING: Unless 'pstr' character array is pre-/post-terminated, NULL-character
N* terminate option DISABLED will cause character string run-on.
N*
N* (5) (a) Format buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (b) To prevent character buffer overrun :
N*
N* Character array size MUST be >= ('nbr_dig' +
N* 1 'NUL' terminator) characters
N*
N* (6) For any unsuccessful string format or error(s), an invalid string of question marks
N* ('?') will be formatted, where the number of question marks is determined by the
N* number of digits to format ('nbr_dig') :
N*
N* Invalid string's { (a) 0 (NULL string) , if 'nbr_dig' = 0
N* number of = {
N* question marks { (b) 'nbr_dig' , if 'nbr_dig' > 0
N*
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_FmtNbr_Int32U (CPU_INT32U nbr,
N CPU_INT08U nbr_dig,
N CPU_INT08U nbr_base,
N CPU_CHAR lead_char,
N CPU_BOOLEAN lower_case,
N CPU_BOOLEAN nul,
N CPU_CHAR *pstr)
N{
N CPU_CHAR *pstr_fmt;
N
N
N pstr_fmt = Str_FmtNbr_Int32(nbr, /* Fmt unsigned int into str. */
N nbr_dig,
N nbr_base,
N DEF_NO,
X 0u,
N lead_char,
N lower_case,
N nul,
N pstr);
N
N return (pstr_fmt);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_FmtNbr_Int32S()
N*
N* Description : Format 32-bit signed integer into a multi-digit character string.
N*
N* Argument(s) : nbr Number to format.
N*
N* nbr_dig Number of digits to format (see Note #1).
N*
N* The following may be used to specify the number of digits to format :
N*
N* DEF_INT_32S_NBR_DIG_MIN + 1 Minimum number of 32-bit signed digits
N* DEF_INT_32S_NBR_DIG_MAX + 1 Maximum number of 32-bit signed digits
N* (plus 1 digit for possible negative sign)
N*
N* nbr_base Base of number to format (see Note #2).
N*
N* The following may be used to specify the number base :
N*
N* DEF_NBR_BASE_BIN Base 2
N* DEF_NBR_BASE_OCT Base 8
N* DEF_NBR_BASE_DEC Base 10
N* DEF_NBR_BASE_HEX Base 16
N*
N* lead_char Prepend leading character (see Note #3) :
N*
N* '\0' Do NOT prepend leading character to string.
N* Printable character Prepend leading character to string.
N* Unprintable character Format invalid string (see Note #6).
N*
N* lower_case Format alphabetic characters (if any) in lower case :
N*
N* DEF_NO Format alphabetic characters in upper case.
N* DEF_YES Format alphabetic characters in lower case.
N*
N* nul Append terminating NULL-character (see Note #4) :
N*
N* DEF_NO Do NOT append terminating NULL-character to string.
N* DEF_YES Append terminating NULL-character to string.
N*
N* pstr Pointer to character array to return formatted number string (see Note #5).
N*
N* Return(s) : Pointer to formatted string, if NO error(s).
N*
N* Pointer to NULL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) If the number of digits to format ('nbr_dig') is zero; then NO formatting
N* is performed except possible NULL-termination of the string (see Note #4).
N*
N* Example :
N*
N* nbr = -23456
N* nbr_dig = 0
N* nbr_base = 10
N*
N* pstr = "" See Note #6a
N*
N* (b) If the number of digits to format ('nbr_dig') is less than the number of
N* significant integer digits of the number to format ('nbr'); then an invalid
N* string is formatted instead of truncating any significant integer digits.
N*
N* Example :
N*
N* nbr = 23456
N* nbr_dig = 3
N* nbr_base = 10
N*
N* pstr = "???" See Note #6b
N*
N* (c) If the number to format ('nbr') is negative but the number of digits to format
N* ('nbr_dig') is equal to the number of significant integer digits of the number
N* to format ('nbr'); then an invalid string is formatted instead of truncating
N* the negative sign.
N*
N* Example :
N*
N* nbr = -23456
N* nbr_dig = 5
N* nbr_base = 10
N*
N* pstr = "?????" See Note #6b
N*
N* (2) The number's base MUST be between 2 & 36, inclusive.
N*$PAGE*
N* (3) Leading character option prepends leading characters prior to the first non-zero digit.
N*
N* (a) (1) Leading character MUST be a printable ASCII character.
N*
N* (2) (A) Leading character MUST NOT be a number base digit, ...
N* (B) with the exception of '0'.
N*
N* (b) (1) The number of leading characters is such that the total number of significant
N* integer digits plus the number of leading characters plus possible negative
N* sign character is equal to the requested number of integer digits to format
N* ('nbr_dig').
N*
N* Examples :
N*
N* nbr = 23456
N* nbr_dig = 7
N* nbr_base = 10
N* lead_char = ' '
N*
N* pstr = " 23456"
N*
N*
N* nbr = -23456
N* nbr_dig = 7
N* nbr_base = 10
N* lead_char = ' '
N*
N* pstr = " -23456"
N*
N* (2) (A) If the number to format ('nbr') is negative AND the leading character
N* ('lead_char') is a '0' digit; then the negative sign character
N* prefixes all leading characters prior to the formatted number.
N*
N* Examples :
N*
N* nbr = -23456
N* nbr_dig = 8
N* nbr_base = 10
N* lead_char = '0'
N*
N* pstr = "-0023456"
N*
N*
N* nbr = -43981
N* nbr_dig = 8
N* nbr_base = 16
N* lead_char = '0'
N* lower_case = DEF_NO
N*
N* pstr = "-000ABCD"
N*
N* (B) If the number to format ('nbr') is negative AND the leading character
N* ('lead_char') is NOT a '0' digit; then the negative sign character
N* immediately prefixes the most significant digit of the formatted number.
N*
N* Examples :
N*
N* nbr = -23456
N* nbr_dig = 8
N* nbr_base = 10
N* lead_char = '#'
N*
N* pstr = "##-23456"
N*
N*
N* nbr = -43981
N* nbr_dig = 8
N* nbr_base = 16
N* lead_char = '#'
N* lower_case = DEF_YES
N*
N* pstr = "###-abcd"
N*
N* (c) (1) If the value of the number to format is zero ...
N* (2) ... & the number of digits to format is non-zero, ...
N* (3) ... but NO leading character available; ...
N* (4) ... then one digit of '0' value is formatted.
N*
N* This is NOT a leading character; but a single integer digit of '0' value.
N*$PAGE*
N* (4) (a) NULL-character terminate option DISABLED prevents overwriting previous character
N* array formatting.
N*
N* (b) WARNING: Unless 'pstr' character array is pre-/post-terminated, NULL-character
N* terminate option DISABLED will cause character string run-on.
N*
N* (5) (a) Format buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (b) To prevent character buffer overrun :
N*
N* Character array size MUST be >= ('nbr_dig' +
N* 1 negative sign +
N* 1 'NUL' terminator) characters
N*
N* (6) For any unsuccessful string format or error(s), an invalid string of question marks
N* ('?') will be formatted, where the number of question marks is determined by the
N* number of digits to format ('nbr_dig') :
N*
N* Invalid string's { (a) 0 (NULL string) , if 'nbr_dig' = 0
N* number of = {
N* question marks { (b) 'nbr_dig' , if 'nbr_dig' > 0
N*
N*********************************************************************************************************
N*/
N
NCPU_CHAR *Str_FmtNbr_Int32S (CPU_INT32S nbr,
N CPU_INT08U nbr_dig,
N CPU_INT08U nbr_base,
N CPU_CHAR lead_char,
N CPU_BOOLEAN lower_case,
N CPU_BOOLEAN nul,
N CPU_CHAR *pstr)
N{
N CPU_CHAR *pstr_fmt;
N CPU_INT32S nbr_fmt;
N CPU_BOOLEAN nbr_neg;
N
N
N if (nbr < 0) { /* If nbr neg, ... */
N nbr_fmt = -nbr; /* ... negate nbr. */
N nbr_neg = DEF_YES;
X nbr_neg = 1u;
N } else {
N nbr_fmt = nbr;
N nbr_neg = DEF_NO;
X nbr_neg = 0u;
N }
N
N pstr_fmt = Str_FmtNbr_Int32((CPU_INT32U)nbr_fmt, /* Fmt signed int into str. */
N nbr_dig,
N nbr_base,
N nbr_neg,
N lead_char,
N lower_case,
N nul,
N pstr);
N
N return (pstr_fmt);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_FmtNbr_32()
N*
N* Description : Format number into a multi-digit character string.
N*
N* Argument(s) : nbr Number to format (see Note #1).
N*
N* nbr_dig Number of decimal digits to format (see Note #2).
N*
N* nbr_dp Number of decimal point digits to format.
N*
N* lead_char Prepend leading character (see Note #3) :
N*
N* '\0' Do NOT prepend leading character to string.
N* Printable character Prepend leading character to string.
N* Unprintable character Format invalid string (see Note #6d).
N*
N* nul Append terminating NULL-character (see Note #4) :
N*
N* DEF_NO Do NOT append terminating NULL-character to string.
N* DEF_YES Append terminating NULL-character to string.
N*
N* pstr Pointer to character array to return formatted number string (see Note #5).
N*
N* Return(s) : Pointer to formatted string, if NO error(s) [see Note #6c].
N*
N* Pointer to NULL, otherwise.
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) (a) The maximum accuracy for 32-bit floating-point numbers :
N*
N*
N* Maximum Accuracy log [Internal-Base ^ (Number-Internal-Base-Digits)]
N* 32-bit Floating-point Number = -----------------------------------------------------
N* log [External-Base]
N*
N* log [2 ^ 24]
N* = --------------
N* log [10]
N*
N* < 7.225 Base-10 Digits
N*
N* where
N* Internal-Base Internal number base of floating-
N* point numbers (i.e. 2)
N* External-Base External number base of floating-
N* point numbers (i.e. 10)
N* Number-Internal-Base-Digits Number of internal number base
N* significant digits (i.e. 24)
N*
N* (b) Some CPUs' &/or compilers' floating-point implementations MAY further reduce the
N* maximum accuracy.
N*$PAGE*
N* (2) (a) If the total number of digits to format ('nbr_dig + nbr_dp') is zero; then NO
N* formatting is performed except possible NULL-termination of the string (see Note #4).
N*
N* Example :
N*
N* nbr = -23456.789
N* nbr_dig = 0
N* nbr_dp = 0
N*
N* pstr = "" See Note #7a
N*
N* (b) (1) If the number of digits to format ('nbr_dig') is less than the number of
N* significant integer digits of the number to format ('nbr'); then an invalid
N* string is formatted instead of truncating any significant integer digits.
N*
N* Example :
N*
N* nbr = 23456.789
N* nbr_dig = 3
N* nbr_dp = 2
N*
N* pstr = "??????" See Note #7d
N*
N* (2) If the number to format ('nbr') is negative but the number of digits to format
N* ('nbr_dig') is equal to the number of significant integer digits of the number
N* to format ('nbr'); then an invalid string is formatted instead of truncating
N* the negative sign.
N*
N* Example :
N*
N* nbr = -23456.789
N* nbr_dig = 5
N* nbr_dp = 2
N*
N* pstr = "????????" See Note #7d
N*
N* (3) If the number to format ('nbr') is negative but the number of significant
N* integer digits is zero, & the number of digits to format ('nbr_dig') is one
N* but the number of decimal point digits to format ('nbr_dp') is zero; then
N* an invalid string is formatted instead of truncating the negative sign.
N*
N* Example :
N*
N* nbr = -0.7895
N* nbr_dig = 1
N* nbr_dp = 0
N*
N* pstr = "?" See Note #7d
N*
N* (4) (A) If the number to format ('nbr') is negative but the number of significant
N* integer digits is zero, & the number of digits to format ('nbr_dig') is
N* zero but the number of decimal point digits to format ('nbr_dp') is non-
N* zero; then the negative sign immediately prefixes the decimal point --
N* with NO decimal digits formatted, NOT even a single decimal digit of '0'.
N*
N* Example :
N*
N* nbr = -0.7895
N* nbr_dig = 0
N* nbr_dp = 2
N*
N* pstr = "-.78"
N*
N* (B) If the number to format ('nbr') is positive but the number of significant
N* integer digits is zero, & the number of digits to format ('nbr_dig') is
N* zero but the number of decimal point digits to format ('nbr_dp') is non-
N* zero; then a single decimal digit of '0' prefixes the decimal point.
N*
N* This '0' digit is used whenever a negative sign is not formatted (see
N* Note #2b4A) so that the formatted string's decimal point is not floating,
N* but fixed in the string as the 2nd character.
N*
N* Example :
N*
N* nbr = 0.7895
N* nbr_dig = 0
N* nbr_dp = 2
N*
N* pstr = "0.78"
N*$PAGE*
N* (c) (1) If the total number of digits to format ('nbr_dig + nbr_dp') is greater than ... :
N*
N* (A) ... the maximum accuracy of the CPU's &/or compiler's 32-bit floating-point
N* numbers, digits following all significantly-accurate digits of the number to
N* format ('nbr') will be inaccurate; ...
N* (B) ... the configured maximum accuracy ('LIB_STR_CFG_FP_MAX_NBR_DIG_SIG'), all
N* digits or decimal places following all significantly-accurate digits of the
N* number to format ('nbr') will be replaced & formatted with zeros ('0').
N*
N* Example :
N*
N* nbr = 123456789.012345
N* nbr_dig = 9
N* nbr_dp = 6
N* LIB_STR_CFG_FP_MAX_NBR_DIG_SIG = 7
N*
N* pstr = "123456700.000000"
N*
N* (2) Therefore, one or more least-significant digit(s) of the number to format ('nbr')
N* MAY be rounded & not necessarily truncated due to the inaccuracy of the CPU's
N* &/or compiler's floating-point implementation.
N*
N* See also Note #1.
N*
N* (3) Leading character option prepends leading characters prior to the first non-zero digit.
N*
N* (a) (1) Leading character MUST be a printable ASCII character.
N*
N* (2) (A) Leading character MUST NOT be a base-10 digit, ...
N* (B) with the exception of '0'.
N*
N* (b) (1) The number of leading characters is such that the total number of significant
N* integer digits plus the number of leading characters plus possible negative
N* sign character is equal to the requested number of integer digits to format
N* ('nbr_dig').
N*
N* Examples :
N*
N* nbr = 23456.789
N* nbr_dig = 7
N* nbr_dp = 2
N* lead_char = ' '
N*
N* pstr = " 23456.78"
N*
N*
N* nbr = -23456.789
N* nbr_dig = 7
N* nbr_dp = 2
N* lead_char = ' '
N*
N* pstr = " -23456.78"
N*
N* (2) (A) If the number to format ('nbr') is negative AND the leading character
N* ('lead_char') is a '0' digit; then the negative sign character
N* prefixes all leading characters prior to the formatted number.
N*
N* Example :
N*
N* nbr = -23456.789
N* nbr_dig = 8
N* nbr_dp = 2
N* lead_char = '0'
N*
N* pstr = "-0023456.78"
N*
N* (B) If the number to format ('nbr') is negative AND the leading character
N* ('lead_char') is NOT a '0' digit; then the negative sign character
N* immediately prefixes the most significant digit of the formatted number.
N*
N* Examples :
N*
N* nbr = -23456.789
N* nbr_dig = 8
N* nbr_dp = 2
N* lead_char = '#'
N*
N* pstr = "##-23456.78"
N*
N* (c) (1) If the integer value of the number to format is zero & ...
N* (2) ... the number of digits to format is greater than one ...
N* (3) ... OR the number is NOT negative, ...
N* (4) ... but NO leading character available; ...
N* (5) ... then one digit of '0' value is formatted.
N*
N* This is NOT a leading character; but a single integer digit of '0' value.
N*
N* See also Note #2b4B.
N*$PAGE*
N* (4) (a) NULL-character terminate option DISABLED prevents overwriting previous character
N* array formatting.
N*
N* (b) WARNING: Unless 'pstr' character array is pre-/post-terminated, NULL-character
N* terminate option DISABLED will cause character string run-on.
N*
N* (5) (a) Format buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (b) To prevent character buffer overrun :
N*
N* Character array size MUST be >= ('nbr_dig' +
N* 'nbr_dp' +
N* 1 negative sign +
N* 1 decimal point +
N* 1 'NUL' terminator) characters
N*
N* (6) String format terminates when :
N*
N* (a) Format string pointer is passed a NULL pointer.
N* (1) No string formatted; NULL pointer returned.
N*
N* (b) Total number of digits to format ('nbr_dig + nbr_dp') is zero.
N* (1) NULL string formatted (see Note #7a); NULL pointer returned.
N*
N* (c) Number of digits to format ('nbr_dig') is less than number of significant
N* integer digits of the number to format ('nbr'), including possible
N* negative sign.
N* (1) Invalid string formatted (see Note #7); NULL pointer returned.
N*
N* (d) Lead character is NOT a valid, printable character (see Note #3a).
N* (1) Invalid string formatted (see Note #7); NULL pointer returned.
N*
N* (e) Number successfully formatted into character string array.
N*
N* (7) For any unsuccessful string format or error(s), an invalid string of question marks
N* ('?') will be formatted, where the number of question marks is determined by the
N* number of digits ('nbr_dig') & number of decimal point digits ('nbr_dp') to format :
N*
N* { (a) 0 (NULL string) , if 'nbr_dig' = 0 AND
N* { 'nbr_dp' = 0
N* {
N* { (b) 'nbr_dig' , if 'nbr_dig' > 0 AND
N* { 'nbr_dp' = 0
N* Invalid string's {
N* number of = { (c) ['nbr_dp' + , if 'nbr_dig' = 0 AND
N* question marks { 1 (for decimal point) + 'nbr_dp' > 0
N* { 1 (for negative sign) ]
N* {
N* { (d) ['nbr_dig' + , if 'nbr_dig' > 0 AND
N* { 'nbr_dp' + 'nbr_dp' > 0
N* { 1 (for decimal point) ]
N*
N*********************************************************************************************************
N*/
N
N#if (LIB_STR_CFG_FP_EN == DEF_ENABLED)
X#if (0u == 1u)
SCPU_CHAR *Str_FmtNbr_32 (CPU_FP32 nbr,
S CPU_INT08U nbr_dig,
S CPU_INT08U nbr_dp,
S CPU_CHAR lead_char,
S CPU_BOOLEAN nul,
S CPU_CHAR *pstr)
S{
S CPU_CHAR *pstr_fmt;
S CPU_DATA i;
S CPU_FP32 nbr_fmt;
S CPU_FP32 nbr_log;
S CPU_INT32U nbr_shiftd;
S CPU_INT16U nbr_dig_max;
S CPU_INT16U nbr_dig_sig;
S CPU_INT08U nbr_neg_sign;
S CPU_INT08U dig_val;
S CPU_FP32 dig_exp;
S CPU_FP32 dp_exp;
S CPU_BOOLEAN lead_char_dig;
S CPU_BOOLEAN lead_char_fmtd;
S CPU_BOOLEAN lead_char_0;
S CPU_BOOLEAN fmt_invalid;
S CPU_BOOLEAN print_char;
S CPU_BOOLEAN nbr_neg;
S CPU_BOOLEAN nbr_neg_fmtd;
S
S
S/*$PAGE*/
S /* ---------------- VALIDATE FMT ARGS ----------------- */
S if (pstr == (CPU_CHAR *)0) { /* Rtn NULL if str ptr NULL (see Note #6a). */
S return ((CPU_CHAR *)0);
S }
S
S fmt_invalid = DEF_NO;
S
S if ((nbr_dig < 1) && (nbr_dp < 1)) { /* If nbr digs/dps = 0, ... */
S fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6b). */
S }
S
S if (lead_char != (CPU_CHAR)'\0') {
S print_char = ASCII_IsPrint(lead_char);
S if (print_char != DEF_YES) { /* If lead char non-printable (see Note #3a1), ... */
S fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6d). */
S
S } else if (lead_char != '0') { /* Chk lead char for non-0 dig. */
S lead_char_dig = ASCII_IsDig(lead_char);
S if (lead_char_dig == DEF_YES) { /* If lead char non-0 dig (see Note #3a2A), ... */
S fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6d). */
S }
S }
S }
S
S
S /* ----------------- PREPARE NBR FMT ------------------ */
S pstr_fmt = pstr;
S
S if (fmt_invalid == DEF_NO) {
S if (nbr < 0.0f) { /* If nbr neg, ... */
S nbr_fmt = -nbr; /* ... negate nbr. */
S nbr_neg_sign = 1u;
S nbr_neg = DEF_YES;
S } else {
S nbr_fmt = nbr;
S nbr_neg_sign = 0u;
S nbr_neg = DEF_NO;
S }
S
S nbr_log = nbr_fmt;
S nbr_dig_max = 0u;
S while (nbr_log >= 1.0f) { /* While base-10 digs avail, ... */
S nbr_dig_max++; /* ... calc max nbr digs. */
S nbr_log /= 10.0f;
S }
S
S if (((nbr_dig >= (nbr_dig_max + nbr_neg_sign)) || /* If req'd nbr digs >= (max nbr digs + neg sign) .. */
S (nbr_dig_max < 1)) && /* .. or NO nbr digs, .. */
S ((nbr_dig > 1) || /* .. but NOT [(req'd nbr dig = 1) AND .. */
S (nbr_dp > 0) || /* .. (req'd nbr dp = 0) AND .. */
S (nbr_neg == DEF_NO))) { /* .. ( nbr neg )] (see Note #2b3). */
S /* .. prepare nbr digs to fmt. */
S dig_exp = 1.0f;
S for (i = 1u; i < nbr_dig; i++) {
S dig_exp *= 10.0f;
S }
S
S nbr_neg_fmtd = DEF_NO;
S nbr_dig_sig = 0u;
S lead_char_fmtd = DEF_NO;
S lead_char_0 = (lead_char == '0') /* Chk if lead char a '0' dig (see Note #3b2). */
S ? DEF_YES : DEF_NO;
S
S } else { /* Else if nbr trunc'd, ... */
S fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6c). */
S }
S }
S
S
S/*$PAGE*/
S /* ------------------- FMT NBR STR -------------------- */
S for (i = nbr_dig; i > 0; i--) { /* Fmt str for desired nbr digs : */
S if (fmt_invalid == DEF_NO) {
S if (nbr_dig_sig < LIB_STR_CFG_FP_MAX_NBR_DIG_SIG) { /* If nbr sig digs < max, fmt str digs; ... */
S nbr_shiftd = (CPU_INT32U)(nbr_fmt / dig_exp);
S if ((nbr_shiftd > 0) || /* If shifted nbr > 0 ... */
S (i == 1u)) { /* ... OR on one's dig to fmt (see Note #3c1), ... */
S /* ... calc & fmt dig val; ... */
S if ((nbr_neg == DEF_YES) && /* If nbr neg ... */
S (nbr_neg_fmtd == DEF_NO )) { /* ... but neg sign NOT yet fmt'd; ... */
S
S if (lead_char_fmtd == DEF_YES) { /* ... & if lead char(s) fmt'd, ... */
S pstr_fmt--; /* ... replace last lead char w/ ... */
S }
S *pstr_fmt++ = '-'; /* ... prepend neg sign (see Notes #2b & #3b). */
S nbr_neg_fmtd = DEF_YES;
S }
S
S if (nbr_shiftd > 0) { /* If shifted nbr > 0, ... */
S dig_val = (CPU_INT08U)(nbr_shiftd % 10u);
S *pstr_fmt++ = (CPU_CHAR )(dig_val + '0');
S
S nbr_dig_sig++; /* ... inc nbr sig digs; ... */
S
S } else if ((nbr_dig > 1) || /* ... else if req'd digs > 1 ... */
S (nbr_neg == DEF_NO)) { /* ... or non-neg nbr, ... */
S *pstr_fmt++ = '0'; /* ... fmt one '0' char (see Note #3c5). */
S }
S
S } else if ((nbr_neg == DEF_YES) && /* ... else if nbr neg ... */
S (lead_char_0 == DEF_YES) && /* ... & lead char a '0' dig ... */
S (nbr_neg_fmtd == DEF_NO )) { /* ... but neg sign NOT yet fmt'd, ... */
S
S *pstr_fmt++ = '-'; /* ... prepend neg sign (see Note #3b); ... */
S nbr_neg_fmtd = DEF_YES;
S
S } else if (lead_char != (CPU_CHAR)'\0') { /* ... else if avail, ... */
S *pstr_fmt++ = lead_char; /* ... fmt lead char. */
S lead_char_fmtd = DEF_YES;
S }
S
S dig_exp /= 10.0f; /* Shift to next least-sig dig. */
S
S } else { /* ... else append non-sig 0's (see Note #2c2). */
S *pstr_fmt++ = '0';
S }
S
S } else { /* Else fmt '?' for invalid str (see Note #7). */
S *pstr_fmt++ = '?';
S }
S }
S
S
S/*$PAGE*/
S if (nbr_dp > 0) { /* Fmt str for desired nbr dp : */
S if (nbr_dig < 1) { /* If NO digs fmt'd; ... */
S if (fmt_invalid == DEF_NO) { /* ... nbr fmt valid, ... */
S if ((nbr_neg == DEF_YES) && /* ... nbr neg ... */
S (nbr_neg_fmtd == DEF_NO )) { /* ... but neg sign NOT yet fmt'd, ... */
S *pstr_fmt++ = '-'; /* ... prepend neg sign (see Notes #2b & #3b); ... */
S } else { /* ... else prepend 1 dig of '0' (see Note #3c5) ... */
S *pstr_fmt++ = '0';
S }
S } else { /* ... else fmt '?' for invalid str (see Note #7). */
S *pstr_fmt++ = '?';
S }
S }
S
S if (fmt_invalid == DEF_NO) { /* If nbr fmt valid, ... */
S *pstr_fmt++ = '.'; /* ... append dp prior to dp conversion. */
S } else { /* Else fmt '?' for invalid str (see Note #7). */
S *pstr_fmt++ = '?';
S }
S
S dp_exp = 10.0f;
S for (i = 0u; i < nbr_dp; i++) {
S if (fmt_invalid == DEF_NO) {
S /* If nbr sig digs < max, fmt str dps; ... */
S if (nbr_dig_sig < LIB_STR_CFG_FP_MAX_NBR_DIG_SIG) {
S nbr_shiftd = (CPU_INT32U)(nbr_fmt * dp_exp);
S dig_val = (CPU_INT32U)(nbr_shiftd % 10u);
S *pstr_fmt++ = (CPU_CHAR )(dig_val + '0');
S dp_exp *= 10.0f; /* Shift to next least-sig dp. */
S
S if ((nbr_shiftd > 0) || /* If shifted nbr > 0 ... */
S (nbr_dig_sig > 0)) { /* ... OR > 0 sig digs already fmt'd, ... */
S nbr_dig_sig++; /* ... inc nbr sig digs. */
S }
S
S } else { /* ... else append non-sig 0's (see Note #2c2). */
S *pstr_fmt++ = '0';
S }
S
S } else { /* Else fmt '?' for invalid str (see Note #7). */
S *pstr_fmt++ = '?';
S }
S }
S }
S
S
S if (nul != DEF_NO) { /* If NOT DISABLED, append NULL char (see Note #4). */
S *pstr_fmt = (CPU_CHAR)'\0';
S }
S
S
S if (fmt_invalid != DEF_NO) { /* Rtn NULL for invalid str fmt (see Notes #6a - #6d). */
S return ((CPU_CHAR *)0);
S }
S
S
S return (pstr); /* Rtn ptr to fmt'd str (see Note #6e). */
S}
N#endif
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_ParseNbr_Int32U()
N*
N* Description : Parse 32-bit unsigned integer from string.
N*
N* Argument(s) : pstr Pointer to string (see Notes #1 & #2a).
N*
N* pstr_next Optional pointer to a variable to ... :
N*
N* (a) Return a pointer to first character following the integer string,
N* if NO error(s) [see Note #2a2B2];
N* (b) Return a pointer to 'pstr',
N* otherwise (see Note #2a2A2).
N*
N* nbr_base Base of number to parse (see Notes #2a1B1 & #2a2B1).
N*
N* Return(s) : Parsed integer, if integer parsed with NO overflow (see Note #2a3A).
N*
N* DEF_INT_32U_MAX_VAL, if integer parsed but overflowed (see Note #2a3A1).
N*
N* 0, otherwise (see Note #2a3B).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : DESCRIPTION' states that "these
N* functions shall convert the initial portion of the string pointed to by 'str' ('pstr')
N* to a type unsigned long ... representation" :
N*
N* (1) "First, they decompose the input string into three parts" :
N*
N* (A) "An initial, possibly empty, sequence of white-space characters [as specified
N* by isspace()]."
N*
N* (1) "The subject sequence is defined as the longest initial subsequence of the
N* input string, starting with the first non-white-space character that is of
N* the expected form. The subject sequence shall contain no characters if the
N* input string is empty or consists entirely of white-space characters."
N*
N* (B) (1) "A subject sequence interpreted as an integer represented in some radix
N* determined by the value of 'base' ('nbr_base')" :
N*
N* (a) "If the value of 'base' ('nbr_base') is 0, the expected form of the
N* subject sequence is that of a decimal constant, octal constant, or
N* hexadecimal constant" :
N*
N* (1) "A decimal constant begins with a non-zero digit, and consists of a
N* sequence of decimal digits."
N*
N* (2) "An octal constant consists of the prefix '0' optionally followed by
N* a sequence of the digits '0' to '7' only."
N*
N* (3) "A hexadecimal constant consists of the prefix '0x' or '0X' followed
N* by a sequence of the decimal digits and letters 'a' (or 'A') to 'f'
N* (or 'F') with values 10 to 15 respectively."
N*
N* (b) "If the value of 'base' ('nbr_base') is between 2 and 36, the expected form
N* of the subject sequence is a sequence of letters and digits representing
N* an integer with the radix specified by 'base' ('nbr_base')" :
N*
N* (1) (A) "The letters from 'a' (or 'A') to 'z' (or 'Z') inclusive are
N* ascribed the values 10 to 35"; ...
N* (B) "only letters whose ascribed values are less than that of base
N* are permitted."
N*
N* (2) (A) "If the value of 'base' ('nbr_base') is 16, the characters '0x' or
N* '0X' may optionally precede the sequence of letters and digits."
N*
N* (B) Although NO specification states that "if the value of 'base'
N* ('nbr_base') is" 8, the '0' character "may optionally precede
N* the sequence of letters and digits"; it seems reasonable to
N* allow the '0' character to be optionally parsed.
N*
N* (2) "A subject sequence .... may be preceded by a '+' or '-' sign."
N*
N* (a) However, it does NOT seem reasonable to parse & convert a negative number
N* integer string into an unsigned integer.
N*
N* (C) (1) (a) "A final string of one or more unrecognized characters," ...
N* (b) "including the terminating null byte of the input string" ...
N* (2) "other than a sign or a permissible letter or digit."
N*$PAGE*
N* (2) Second, "they shall attempt to convert the subject sequence to an unsigned integer" :
N*
N* (A) "If the subject sequence is empty or does not have the expected form" :
N*
N* (1) "no conversion [is] performed"; ...
N* (2) "the value of 'str' ('pstr') [is] stored in the object pointed to by 'endptr'
N* ('pstr_next'), provided that 'endptr' ('pstr_next') is not a null pointer."
N*
N* (B) "If the subject sequence has the expected form" :
N*
N* (1) (a) "and the value of 'base' ('nbr_base') is 0, the sequence of characters
N* starting with the first digit shall be interpreted as an integer constant."
N*
N* (b) "and the value of 'base' ('nbr_base') is between 2 and 36, it shall be
N* used as the base for conversion, ascribing to each letter its value as
N* given above" (see Note #2a1B1b1A).
N*
N* (2) "A pointer to the final string shall be stored in the object pointed to by
N* 'endptr' ('pstr_next'), provided that 'endptr' ('pstr_next') is not a null
N* pointer."
N*
N* (3) Lastly, IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : RETURN VALUE' states that :
N*
N* (A) "Upon successful completion, these functions shall return the converted value."
N* (1) "If the correct value is outside the range of representable values, {ULONG_MAX}
N* ... shall be returned."
N*
N* (B) "If no conversion could be performed, 0 shall be returned."
N*
N* (b) (1) IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : ERRORS' states that "these functions
N* shall fail if" :
N*
N* (A) "[EINVAL] - The value of 'base' ('nbr_base') is not supported."
N*
N* (B) "[ERANGE] - The value to be returned is not representable."
N*
N* (2) IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : ERRORS' states that "these functions
N* may fail if" :
N*
N* (A) "[EINVAL] - No conversion could be performed."
N*
N* (3) Return integer value & next string pointer should be used to diagnose parse success or failure :
N*
N* (a) Valid parse string integer :
N*
N* pstr = " ABCDE xyz"
N* nbr_base = 16
N*
N* nbr = 703710
N* pstr_next = " xyz"
N*
N*
N* (b) Invalid parse string integer :
N*
N* pstr = " ABCDE"
N* nbr_base = 10
N*
N* nbr = 0
N* pstr_next = pstr = " ABCDE"
N*
N*
N* (c) Valid hexadecimal parse string integer :
N*
N* pstr = " 0xGABCDE"
N* nbr_base = 16
N*
N* nbr = 0
N* pstr_next = "xGABCDE"
N*
N*
N* (d) Valid decimal parse string integer ('0x' prefix ignored
N* following invalid hexadecimal characters) :
N*
N* pstr = " 0xGABCDE"
N* nbr_base = 0
N*
N* nbr = 0
N* pstr_next = "xGABCDE"
N*
N*
N* (e) Valid decimal parse string integer ('0' prefix ignored
N* following invalid octal characters) :
N*
N* pstr = " 0GABCDE"
N* nbr_base = 0
N*
N* nbr = 0
N* pstr_next = "GABCDE"
N*
N*$PAGE*
N* (f) Parse string integer overflow :
N*
N* pstr = " 12345678901234567890*123456"
N* nbr_base = 10
N*
N* nbr = DEF_INT_32U_MAX_VAL
N* pstr_next = "*123456"
N*
N*
N* (g) Invalid negative unsigned parse string :
N*
N* pstr = " -12345678901234567890*123456"
N* nbr_base = 10
N*
N* nbr = 0
N* pstr_next = pstr = " -12345678901234567890*123456"
N*
N*********************************************************************************************************
N*/
N
NCPU_INT32U Str_ParseNbr_Int32U (const CPU_CHAR *pstr,
N CPU_CHAR **pstr_next,
N CPU_INT08U nbr_base)
N{
N CPU_INT32U nbr;
N
N
N nbr = Str_ParseNbr_Int32( pstr, /* Parse/convert str ... */
N pstr_next,
N nbr_base,
N DEF_NO, /* ... as unsigned int (see Note #2a2). */
X 0u,
N (CPU_BOOLEAN *)0);
N
N return (nbr);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_ParseNbr_Int32S()
N*
N* Description : Parse 32-bit signed integer from string.
N*
N* Argument(s) : pstr Pointer to string (see Notes #1 & #2a).
N*
N* pstr_next Optional pointer to a variable to ... :
N*
N* (a) Return a pointer to first character following the integer string,
N* if NO error(s) [see Note #2a2B2];
N* (b) Return a pointer to 'pstr',
N* otherwise (see Note #2a2A2).
N*
N* nbr_base Base of number to parse (see Notes #2a1B1 & #2a2B1).
N*
N* Return(s) : Parsed integer, if integer parsed with NO over- or underflow (see Note #2a3A).
N*
N* DEF_INT_32S_MIN_VAL, if integer parsed but negatively underflowed (see Note #2a3A1a).
N*
N* DEF_INT_32U_MAX_VAL, if integer parsed but positively overflowed (see Note #2a3A1b).
N*
N* 0, otherwise (see Note #2a3B).
N*
N* Caller(s) : Application.
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strtol() : DESCRIPTION' states that "these
N* functions shall convert the initial portion of the string pointed to by 'str' ('pstr')
N* to a type long ... representation" :
N*
N* (1) "First, they decompose the input string into three parts" :
N*
N* (A) "An initial, possibly empty, sequence of white-space characters [as specified
N* by isspace()]."
N*
N* (1) "The subject sequence is defined as the longest initial subsequence of the
N* input string, starting with the first non-white-space character that is of
N* the expected form. The subject sequence shall contain no characters if the
N* input string is empty or consists entirely of white-space characters."
N*
N* (B) (1) "A subject sequence interpreted as an integer represented in some radix
N* determined by the value of 'base' ('nbr_base')" :
N*
N* (a) "If the value of 'base' ('nbr_base') is 0, the expected form of the
N* subject sequence is that of a decimal constant, octal constant, or
N* hexadecimal constant" :
N*
N* (1) "A decimal constant begins with a non-zero digit, and consists of a
N* sequence of decimal digits."
N*
N* (2) "An octal constant consists of the prefix '0' optionally followed by
N* a sequence of the digits '0' to '7' only."
N*
N* (3) "A hexadecimal constant consists of the prefix '0x' or '0X' followed
N* by a sequence of the decimal digits and letters 'a' (or 'A') to 'f'
N* (or 'F') with values 10 to 15 respectively."
N*
N* (b) "If the value of 'base' ('nbr_base') is between 2 and 36, the expected form
N* of the subject sequence is a sequence of letters and digits representing
N* an integer with the radix specified by 'base' ('nbr_base')" :
N*
N* (1) (A) "The letters from 'a' (or 'A') to 'z' (or 'Z') inclusive are
N* ascribed the values 10 to 35"; ...
N* (B) "only letters whose ascribed values are less than that of base
N* are permitted."
N*
N* (2) (A) "If the value of 'base' ('nbr_base') is 16, the characters '0x' or
N* '0X' may optionally precede the sequence of letters and digits."
N*
N* (B) Although NO specification states that "if the value of 'base'
N* ('nbr_base') is" 8, the '0' character "may optionally precede
N* the sequence of letters and digits"; it seems reasonable to
N* allow the '0' character to be optionally parsed.
N*
N* (2) "A subject sequence .... may be preceded by a '+' or '-' sign."
N*
N* (a) However, it does NOT seem reasonable to parse & convert a negative number
N* integer string into an unsigned integer.
N*
N* (C) (1) (a) "A final string of one or more unrecognized characters," ...
N* (b) "including the terminating null byte of the input string" ...
N* (2) "other than a sign or a permissible letter or digit."
N*$PAGE*
N* (2) Second, "they shall attempt to convert the subject sequence to an integer" :
N*
N* (A) "If the subject sequence is empty or does not have the expected form" :
N*
N* (1) "no conversion is performed"; ...
N* (2) "the value of 'str' ('pstr') is stored in the object pointed to by 'endptr'
N* ('pstr_next'), provided that 'endptr' ('pstr_next') is not a null pointer."
N*
N* (B) "If the subject sequence has the expected form" :
N*
N* (1) (a) "and the value of 'base' ('nbr_base') is 0, the sequence of characters
N* starting with the first digit shall be interpreted as an integer constant."
N*
N* (b) "and the value of 'base' ('nbr_base') is between 2 and 36, it shall be
N* used as the base for conversion, ascribing to each letter its value as
N* given above" (see Note #2a1B1b1A).
N*
N* (2) "A pointer to the final string shall be stored in the object pointed to by
N* 'endptr' ('pstr_next'), provided that 'endptr' ('pstr_next') is not a null
N* pointer."
N*
N* (3) Lastly, IEEE Std 1003.1, 2004 Edition, Section 'strtol() : RETURN VALUE' states that :
N*
N* (A) "Upon successful completion, these functions shall return the converted value."
N*
N* (1) "If the correct value is outside the range of representable values", either
N* of the following "shall be returned" :
N* (a) "{LONG_MIN}" or ...
N* (b) "{LONG_MAX}"
N*
N* (B) "If no conversion could be performed, 0 shall be returned."
N*
N* (b) (1) IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : ERRORS' states that "these functions
N* shall fail if" :
N*
N* (A) "[EINVAL] - The value of 'base' ('nbr_base') is not supported."
N*
N* (B) "[ERANGE] - The value to be returned is not representable."
N*
N* (2) IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : ERRORS' states that "these functions
N* may fail if" :
N*
N* (A) "[EINVAL] - No conversion could be performed."
N*
N* (3) Return integer value & next string pointer should be used to diagnose parse success or failure :
N*
N* (a) Valid parse string integer :
N*
N* pstr = " ABCDE xyz"
N* nbr_base = 16
N*
N* nbr = 703710
N* pstr_next = " xyz"
N*
N*
N* (b) Invalid parse string integer :
N*
N* pstr = " ABCDE"
N* nbr_base = 10
N*
N* nbr = 0
N* pstr_next = pstr = " ABCDE"
N*
N*
N* (c) Valid hexadecimal parse string integer :
N*
N* pstr = " 0xGABCDE"
N* nbr_base = 16
N*
N* nbr = 0
N* pstr_next = "xGABCDE"
N*
N*
N* (d) Valid decimal parse string integer ('0x' prefix ignored
N* following invalid hexadecimal characters) :
N*
N* pstr = " 0xGABCDE"
N* nbr_base = 0
N*
N* nbr = 0
N* pstr_next = "xGABCDE"
N*
N*
N* (e) Valid decimal parse string integer ('0' prefix ignored
N* following invalid octal characters) :
N*
N* pstr = " 0GABCDE"
N* nbr_base = 0
N*
N* nbr = 0
N* pstr_next = "GABCDE"
N*
N*$PAGE*
N* (f) Parse string integer overflow :
N*
N* pstr = " 12345678901234567890*123456"
N* nbr_base = 10
N*
N* nbr = DEF_INT_32S_MAX_VAL
N* pstr_next = "*123456"
N*
N*
N* (g) Parse string integer underflow :
N*
N* pstr = " -12345678901234567890*123456"
N* nbr_base = 10
N*
N* nbr = DEF_INT_32S_MIN_VAL
N* pstr_next = "*123456"
N*
N*********************************************************************************************************
N*/
N
NCPU_INT32S Str_ParseNbr_Int32S (const CPU_CHAR *pstr,
N CPU_CHAR **pstr_next,
N CPU_INT08U nbr_base)
N{
N CPU_INT32S nbr;
N CPU_INT32U nbr_abs;
N CPU_BOOLEAN nbr_neg;
N
N
N nbr_abs = Str_ParseNbr_Int32(pstr, /* Parse/convert str ... */
N pstr_next,
N nbr_base,
N DEF_YES, /* ... as signed int (see Note #2a2). */
X 1u,
N &nbr_neg);
N
N if (nbr_neg == DEF_NO) { /* Chk for neg nbr & ovf/undf (see Note #2a3A1). */
X if (nbr_neg == 0u) {
N nbr = (nbr_abs > (CPU_INT32U) DEF_INT_32S_MAX_VAL) ? (CPU_INT32S)DEF_INT_32S_MAX_VAL
X nbr = (nbr_abs > (CPU_INT32U) 2147483647) ? (CPU_INT32S)2147483647
N : (CPU_INT32S)nbr_abs;
N } else {
N nbr = (nbr_abs > (CPU_INT32U)-DEF_INT_32S_MIN_VAL_ONES_CPL) ? (CPU_INT32S)DEF_INT_32S_MIN_VAL
X nbr = (nbr_abs > (CPU_INT32U)-(-2147483647)) ? (CPU_INT32S)((-2147483647) - 1)
N : -(CPU_INT32S)nbr_abs;
N }
N
N return (nbr);
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N*********************************************************************************************************
N* LOCAL FUNCTIONS
N*********************************************************************************************************
N*********************************************************************************************************
N*/
N
N/*
N*********************************************************************************************************
N* Str_FmtNbr_Int32()
N*
N* Description : Format 32-bit integer into a multi-digit character string.
N*
N* Argument(s) : nbr Number to format.
N*
N* nbr_dig Number of digits to format (see Note #1).
N*
N* nbr_base Base of number to format (see Note #2).
N*
N* nbr_neg Indicates whether number to format is negative :
N* -------
N* DEF_NO Number is non-negative.
N* DEF_YES Number is negative.
N*
N* Argument validated in Str_FmtNbr_Int32U(),
N* Str_FmtNbr_Int32S().
N*
N* lead_char Prepend leading character (see Note #3) :
N*
N* '\0' Do NOT prepend leading character to string.
N* Printable character Prepend leading character to string.
N* Unprintable character Format invalid string (see Note #6e).
N*
N* lower_case Format alphabetic characters (if any) in lower case :
N*
N* DEF_NO Format alphabetic characters in upper case.
N* DEF_YES Format alphabetic characters in lower case.
N*
N* nul Append terminating NULL-character (see Note #4) :
N*
N* DEF_NO Do NOT append terminating NULL-character to string.
N* DEF_YES Append terminating NULL-character to string.
N*
N* pstr Pointer to character array to return formatted number string (see Note #5).
N*
N* Return(s) : Pointer to formatted string, if NO error(s) [see Note #6f].
N*
N* Pointer to NULL, otherwise.
N*
N* Caller(s) : Str_FmtNbr_Int32U(),
N* Str_FmtNbr_Int32S().
N*$PAGE*
N* Note(s) : (1) (a) The maximum number of digits to format for 32-bit integer numbers :
N*
N*
N* Maximum Number of [ log (Number) ]
N* 32-bit Integer Digits = floor [ -------------- + 1 ]
N* to Format [ log (Base) ]
N*
N* where
N* Number Number to format
N* Base Base of number to format
N*
N* (b) (1) If the number of digits to format ('nbr_dig') is zero; then NO formatting
N* is performed except possible NULL-termination of the string (see Note #4).
N*
N* Example :
N*
N* nbr = -23456
N* nbr_dig = 0
N* nbr_base = 10
N*
N* pstr = "" See Note #7a
N*
N* (2) If the number of digits to format ('nbr_dig') is less than the number of
N* significant integer digits of the number to format ('nbr'); then an invalid
N* string is formatted instead of truncating any significant integer digits.
N*
N* Example :
N*
N* nbr = 23456
N* nbr_dig = 3
N* nbr_base = 10
N*
N* pstr = "???" See Note #7b
N*
N* (3) If the number to format ('nbr') is negative but the number of digits to format
N* ('nbr_dig') is equal to the number of significant integer digits of the number
N* to format ('nbr'); then an invalid string is formatted instead of truncating
N* the negative sign.
N*
N* Example :
N*
N* nbr = -23456
N* nbr_dig = 5
N* nbr_base = 10
N*
N* pstr = "?????" See Note #7b
N*
N* (2) The number's base MUST be between 2 & 36, inclusive.
N*$PAGE*
N* (3) Leading character option prepends leading characters prior to the first non-zero digit.
N*
N* (a) (1) Leading character MUST be a printable ASCII character.
N*
N* (2) (A) Leading character MUST NOT be a number base digit, ...
N* (B) with the exception of '0'.
N*
N* (b) (1) The number of leading characters is such that the total number of significant
N* integer digits plus the number of leading characters plus possible negative
N* sign character is equal to the requested number of integer digits to format
N* ('nbr_dig').
N*
N* Examples :
N*
N* nbr = 23456
N* nbr_dig = 7
N* nbr_base = 10
N* lead_char = ' '
N*
N* pstr = " 23456"
N*
N*
N* nbr = -23456
N* nbr_dig = 7
N* nbr_base = 10
N* lead_char = ' '
N*
N* pstr = " -23456"
N*
N* (2) (A) If the number to format ('nbr') is negative AND the leading character
N* ('lead_char') is a '0' digit; then the negative sign character
N* prefixes all leading characters prior to the formatted number.
N*
N* Examples :
N*
N* nbr = -23456
N* nbr_dig = 8
N* nbr_base = 10
N* lead_char = '0'
N*
N* pstr = "-0023456"
N*
N*
N* nbr = -43981
N* nbr_dig = 8
N* nbr_base = 16
N* lead_char = '0'
N* lower_case = DEF_NO
N*
N* pstr = "-000ABCD"
N*
N* (B) If the number to format ('nbr') is negative AND the leading character
N* ('lead_char') is NOT a '0' digit; then the negative sign character
N* immediately prefixes the most significant digit of the formatted number.
N*
N* Examples :
N*
N* nbr = -23456
N* nbr_dig = 8
N* nbr_base = 10
N* lead_char = '#'
N*
N* pstr = "##-23456"
N*
N*
N* nbr = -43981
N* nbr_dig = 8
N* nbr_base = 16
N* lead_char = '#'
N* lower_case = DEF_YES
N*
N* pstr = "###-abcd"
N*
N* (c) (1) If the value of the number to format is zero ...
N* (2) ... & the number of digits to format is non-zero, ...
N* (3) ... but NO leading character available; ...
N* (4) ... then one digit of '0' value is formatted.
N*
N* This is NOT a leading character; but a single integer digit of '0' value.
N*$PAGE*
N* (4) (a) NULL-character terminate option DISABLED prevents overwriting previous character
N* array formatting.
N*
N* (b) WARNING: Unless 'pstr' character array is pre-/post-terminated, NULL-character
N* terminate option DISABLED will cause character string run-on.
N*
N* (5) (a) Format buffer size NOT validated; buffer overruns MUST be prevented by caller.
N*
N* (b) To prevent character buffer overrun :
N*
N* Character array size MUST be >= ('nbr_dig' +
N* 1 negative sign +
N* 1 'NUL' terminator) characters
N*
N* (6) String format terminates when :
N*
N* (a) Format string pointer is passed a NULL pointer.
N* (1) No string formatted; NULL pointer returned.
N*
N* (b) Number of digits to format ('nbr_dig') is zero.
N* (1) NULL string formatted (see Note #7a); NULL pointer returned.
N*
N* (c) Number of digits to format ('nbr_dig') is less than number of significant
N* integer digits of the number to format ('nbr'), including possible
N* negative sign.
N* (1) Invalid string formatted (see Note #7); NULL pointer returned.
N*
N* (d) Base is passed an invalid base (see Note #2).
N* (1) Invalid string format performed; NULL pointer returned.
N*
N* (e) Lead character is NOT a valid, printable character (see Note #3a).
N* (1) Invalid string formatted (see Note #7); NULL pointer returned.
N*
N* (f) Number successfully formatted into character string array.
N*
N* (7) For any unsuccessful string format or error(s), an invalid string of question marks
N* ('?') will be formatted, where the number of question marks is determined by the
N* number of digits to format ('nbr_dig') :
N*
N* Invalid string's { (a) 0 (NULL string) , if 'nbr_dig' = 0
N* number of = {
N* question marks { (b) 'nbr_dig' , if 'nbr_dig' > 0
N*
N*********************************************************************************************************
N*/
N
Nstatic CPU_CHAR *Str_FmtNbr_Int32 (CPU_INT32U nbr,
N CPU_INT08U nbr_dig,
N CPU_INT08U nbr_base,
N CPU_BOOLEAN nbr_neg,
N CPU_CHAR lead_char,
N CPU_BOOLEAN lower_case,
N CPU_BOOLEAN nul,
N CPU_CHAR *pstr)
N{
N CPU_CHAR *pstr_fmt;
N CPU_DATA i;
N CPU_INT32U nbr_fmt;
N CPU_INT32U nbr_log;
N CPU_INT08U nbr_dig_max;
N CPU_INT08U nbr_dig_min;
N CPU_INT08U nbr_dig_fmtd;
N CPU_INT08U nbr_neg_sign;
N CPU_INT08U nbr_lead_char;
N CPU_INT08U dig_val;
N CPU_INT08U lead_char_delta_0;
N CPU_INT08U lead_char_delta_a;
N CPU_BOOLEAN lead_char_dig;
N CPU_BOOLEAN lead_char_0;
N CPU_BOOLEAN fmt_invalid;
N CPU_BOOLEAN print_char;
N CPU_BOOLEAN nbr_neg_fmtd;
N
N
N/*$PAGE*/
N /* ---------------- VALIDATE FMT ARGS ----------------- */
N if (pstr == (CPU_CHAR *)0) { /* Rtn NULL if str ptr NULL (see Note #6a). */
N return ((CPU_CHAR *)0);
N }
N
N fmt_invalid = DEF_NO;
X fmt_invalid = 0u;
N
N if (nbr_dig < 1) { /* If nbr digs = 0, ... */
N fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6b). */
X fmt_invalid = 1u;
N }
N /* If invalid base, ... */
N if ((nbr_base < 2u) ||
N (nbr_base > 36u)) {
N fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6d). */
X fmt_invalid = 1u;
N }
N
N if (lead_char != (CPU_CHAR)'\0') {
N print_char = ASCII_IsPrint(lead_char);
N if (print_char != DEF_YES) { /* If lead char non-printable (see Note #3a1), ... */
X if (print_char != 1u) {
N fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6e). */
X fmt_invalid = 1u;
N
N } else if (lead_char != '0') { /* Chk lead char for non-0 nbr base dig. */
N lead_char_delta_0 = (CPU_INT08U)(lead_char - '0');
N if (lower_case != DEF_YES) {
X if (lower_case != 1u) {
N lead_char_delta_a = (CPU_INT08U)(lead_char - 'A');
N } else {
N lead_char_delta_a = (CPU_INT08U)(lead_char - 'a');
N }
N
N lead_char_dig = (((nbr_base <= 10u) && (lead_char_delta_0 < nbr_base)) ||
N ((nbr_base > 10u) && ((lead_char_delta_0 < 10u) ||
N (lead_char_delta_a < (nbr_base - 10u))))) ? DEF_YES : DEF_NO;
X (lead_char_delta_a < (nbr_base - 10u))))) ? 1u : 0u;
N
N if (lead_char_dig == DEF_YES) { /* If lead char non-0 nbr base dig (see Note #3a2A), ...*/
X if (lead_char_dig == 1u) {
N fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6e). */
X fmt_invalid = 1u;
N }
N }
N }
N
N
N /* ----------------- PREPARE NBR FMT ------------------ */
N pstr_fmt = pstr;
N
N if (fmt_invalid == DEF_NO) {
X if (fmt_invalid == 0u) {
N nbr_fmt = nbr;
N nbr_log = nbr;
N nbr_dig_max = 1u;
N while (nbr_log >= nbr_base) { /* While nbr base digs avail, ... */
N nbr_dig_max++; /* ... calc max nbr digs. */
N nbr_log /= nbr_base;
N }
N
N nbr_neg_sign = (nbr_neg == DEF_YES) ? 1u : 0u;
X nbr_neg_sign = (nbr_neg == 1u) ? 1u : 0u;
N if (nbr_dig >= (nbr_dig_max + nbr_neg_sign)) { /* If req'd nbr digs >= (max nbr digs + neg sign), ... */
N nbr_neg_fmtd = DEF_NO;
X nbr_neg_fmtd = 0u;
N nbr_dig_min = DEF_MIN(nbr_dig_max, nbr_dig);
X nbr_dig_min = (((nbr_dig_max) < (nbr_dig)) ? (nbr_dig_max) : (nbr_dig));
N /* ... calc nbr digs to fmt & nbr lead chars. */
N if (lead_char != (CPU_CHAR)'\0') {
N nbr_dig_fmtd = nbr_dig;
N nbr_lead_char = nbr_dig -
N nbr_dig_min - nbr_neg_sign;
N } else {
N nbr_dig_fmtd = nbr_dig_min + nbr_neg_sign;
N nbr_lead_char = 0u;
N }
N
N if (nbr_lead_char > 0) { /* If lead chars to fmt, ... */
N lead_char_0 = (lead_char == '0') /* ... chk if lead char a '0' dig (see Note #3a2B). */
N ? DEF_YES : DEF_NO;
X ? 1u : 0u;
N } else {
N lead_char_0 = DEF_NO;
X lead_char_0 = 0u;
N }
N
N } else { /* Else if nbr trunc'd, ... */
N fmt_invalid = DEF_YES; /* ... fmt invalid str (see Note #6c). */
X fmt_invalid = 1u;
N }
N }
N
N if (fmt_invalid != DEF_NO) {
X if (fmt_invalid != 0u) {
N nbr_dig_fmtd = nbr_dig;
N }
N
N
N/*$PAGE*/
N /* ------------------- FMT NBR STR -------------------- */
N pstr_fmt += nbr_dig_fmtd; /* Start fmt @ least-sig dig. */
N
N if (nul != DEF_NO) { /* If NOT DISABLED, append NULL char (see Note #4). */
X if (nul != 0u) {
N *pstr_fmt = (CPU_CHAR)'\0';
N }
N pstr_fmt--;
N
N
N for (i = 0u; i < nbr_dig_fmtd; i++) { /* Fmt str for desired nbr digs : */
N if (fmt_invalid == DEF_NO) {
X if (fmt_invalid == 0u) {
N if ((nbr_fmt > 0) || /* If fmt nbr > 0 ... */
N (i == 0u)) { /* ... OR on one's dig to fmt (see Note #3c1), ... */
N /* ... calc & fmt dig val; ... */
N dig_val = (CPU_INT08U)(nbr_fmt % nbr_base);
N if (dig_val < 10u) {
N *pstr_fmt-- = (CPU_CHAR)(dig_val + '0');
N } else {
N if (lower_case != DEF_YES) {
X if (lower_case != 1u) {
N *pstr_fmt-- = (CPU_CHAR)((dig_val - 10u) + 'A');
N } else {
N *pstr_fmt-- = (CPU_CHAR)((dig_val - 10u) + 'a');
N }
N }
N
N nbr_fmt /= nbr_base; /* Shift to next more-sig dig. */
N
N } else if ((nbr_neg == DEF_YES) && /* ... else if nbr neg AND ... */
X } else if ((nbr_neg == 1u) &&
N (((lead_char_0 == DEF_NO ) && /* ... lead char NOT a '0' dig ... */
X (((lead_char_0 == 0u ) &&
N (nbr_neg_fmtd == DEF_NO )) || /* ... but neg sign NOT yet fmt'd OR ... */
X (nbr_neg_fmtd == 0u )) ||
N ((lead_char_0 != DEF_NO ) && /* ... lead char is a '0' dig ... */
X ((lead_char_0 != 0u ) &&
N (i == (nbr_dig_fmtd - 1u))))) { /* ... & on most-sig dig to fmt, ... */
N
N *pstr_fmt-- = '-'; /* ... prepend neg sign (see Note #3b); ... */
N nbr_neg_fmtd = DEF_YES;
X nbr_neg_fmtd = 1u;
N
N } else if (lead_char != (CPU_CHAR)'\0') { /* ... else if avail, ... */
N *pstr_fmt-- = lead_char; /* ... fmt lead char. */
N }
N
N } else { /* Else fmt '?' for invalid str (see Note #7). */
N *pstr_fmt-- = '?';
N }
N }
N
N
N if (fmt_invalid != DEF_NO) { /* Rtn NULL for invalid str fmt (see Notes #6a - #6e). */
X if (fmt_invalid != 0u) {
N return ((CPU_CHAR *)0);
N }
N
N
N return (pstr); /* Rtn ptr to fmt'd str (see Note #6f). */
N}
N
N
N/*$PAGE*/
N/*
N*********************************************************************************************************
N* Str_ParseNbr_Int32()
N*
N* Description : Parse 32-bit integer from string.
N*
N* Argument(s) : pstr Pointer to string (see Notes #1 & #2a).
N*
N* pstr_next Optional pointer to a variable to ... :
N*
N* (a) Return a pointer to first character following the integer string,
N* if NO error(s) [see Note #2a2B2];
N* (b) Return a pointer to 'pstr',
N* otherwise (see Note #2a2A2).
N*
N* nbr_base Base of number to parse (see Notes #2a1B1 & #2a2B1).
N*
N* nbr_signed Indicates whether number to parse is signed :
N*
N* DEF_NO Number is unsigned.
N* DEF_YES Number is signed.
N*
N* pnbr_neg Pointer to a variable to return if the parsed (signed) number is negative :
N*
N* DEF_NO Number is non-negative.
N* DEF_YES Number is negative.
N*
N* Return(s) : Parsed integer, if integer parsed with NO overflow (see Note #2a3A).
N*
N* DEF_INT_32U_MAX_VAL, if integer parsed but overflowed (see Note #2a3A1).
N*
N* 0, otherwise (see Note #2a3B).
N*
N* Caller(s) : Str_ParseNbr_Int32U(),
N* Str_ParseNbr_Int32S().
N*
N* Note(s) : (1) String buffer NOT modified.
N*
N* (2) (a) IEEE Std 1003.1, 2004 Edition, Section 'strtol() : DESCRIPTION' states that "these
N* functions shall convert the initial portion of the string pointed to by 'str' ('pstr')
N* to a type long ... representation" :
N*
N* (1) "First, they decompose the input string into three parts" :
N*
N* (A) "An initial, possibly empty, sequence of white-space characters [as specified
N* by isspace()]."
N*
N* (1) "The subject sequence is defined as the longest initial subsequence of the
N* input string, starting with the first non-white-space character that is of
N* the expected form. The subject sequence shall contain no characters if the
N* input string is empty or consists entirely of white-space characters."
N*
N* (B) (1) "A subject sequence interpreted as an integer represented in some radix
N* determined by the value of 'base' ('nbr_base')" :
N*
N* (a) "If the value of 'base' ('nbr_base') is 0, the expected form of the
N* subject sequence is that of a decimal constant, octal constant, or
N* hexadecimal constant" :
N*
N* (1) "A decimal constant begins with a non-zero digit, and consists of a
N* sequence of decimal digits."
N*
N* (2) "An octal constant consists of the prefix '0' optionally followed by
N* a sequence of the digits '0' to '7' only."
N*
N* (3) "A hexadecimal constant consists of the prefix '0x' or '0X' followed
N* by a sequence of the decimal digits and letters 'a' (or 'A') to 'f'
N* (or 'F') with values 10 to 15 respectively."
N*
N* (b) "If the value of 'base' ('nbr_base') is between 2 and 36, the expected form
N* of the subject sequence is a sequence of letters and digits representing
N* an integer with the radix specified by 'base' ('nbr_base')" :
N*
N* (1) (A) "The letters from 'a' (or 'A') to 'z' (or 'Z') inclusive are
N* ascribed the values 10 to 35"; ...
N* (B) "only letters whose ascribed values are less than that of base
N* are permitted."
N*
N* (2) (A) "If the value of 'base' ('nbr_base') is 16, the characters '0x' or
N* '0X' may optionally precede the sequence of letters and digits."
N*
N* (B) Although NO specification states that "if the value of 'base'
N* ('nbr_base') is" 8, the '0' character "may optionally precede
N* the sequence of letters and digits"; it seems reasonable to
N* allow the '0' character to be optionally parsed.
N*$PAGE*
N* (2) "A subject sequence .... may be preceded by a '+' or '-' sign."
N*
N* (a) It does NOT seem reasonable to parse & convert a negative number
N* integer string into an unsigned integer. However, a negative sign
N* for an unsigned integer will automatically be parsed as an invalid
N* character (see Note #2aC1).
N*
N* (C) (1) (a) "A final string of one or more unrecognized characters," ...
N* (b) "including the terminating null byte of the input string" ...
N* (2) "other than a sign or a permissible letter or digit."
N*
N* (2) Second, "they shall attempt to convert the subject sequence to an integer" :
N*
N* (A) "If the subject sequence is empty or does not have the expected form" :
N*
N* (1) "no conversion is performed"; ...
N* (2) "the value of 'str' ('pstr') is stored in the object pointed to by 'endptr'
N* ('pstr_next'), provided that 'endptr' ('pstr_next') is not a null pointer."
N*
N* (B) "If the subject sequence has the expected form" :
N*
N* (1) (a) "and the value of 'base' ('nbr_base') is 0, the sequence of characters
N* starting with the first digit shall be interpreted as an integer constant."
N*
N* (b) "and the value of 'base' ('nbr_base') is between 2 and 36, it shall be
N* used as the base for conversion, ascribing to each letter its value as
N* given above" (see Note #2a1B1b1A).
N*
N* (2) "A pointer to the final string shall be stored in the object pointed to by
N* 'endptr' ('pstr_next'), provided that 'endptr' ('pstr_next') is not a null
N* pointer."
N*
N* (3) Lastly, IEEE Std 1003.1, 2004 Edition, Section 'strtol() : RETURN VALUE' states that :
N*
N* (A) "Upon successful completion, these functions shall return the converted value."
N* (1) "If the correct value is outside the range of representable values, {LONG_MIN}
N* [or] {LONG_MAX} ... shall be returned."
N*
N* (B) "If no conversion could be performed, 0 shall be returned."
N*
N* (b) (1) IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : ERRORS' states that "these functions
N* shall fail if" :
N*
N* (A) "[EINVAL] - The value of 'base' ('nbr_base') is not supported."
N*
N* (B) "[ERANGE] - The value to be returned is not representable."
N*
N* (2) IEEE Std 1003.1, 2004 Edition, Section 'strtoul() : ERRORS' states that "these functions
N* may fail if" :
N*
N* (A) "[EINVAL] - No conversion could be performed."
N*$PAGE*
N* (3) Return integer value & next string pointer should be used to diagnose parse success or failure :
N*
N* (a) Valid parse string integer :
N*
N* pstr = " ABCDE xyz"
N* nbr_base = 16
N*
N* nbr = 703710
N* pstr_next = " xyz"
N*
N*
N* (b) Invalid parse string integer :
N*
N* pstr = " ABCDE"
N* nbr_base = 10
N*
N* nbr = 0
N* pstr_next = pstr = " ABCDE"
N*
N*
N* (c) Valid hexadecimal parse string integer :
N*
N* pstr = " 0xGABCDE"
N* nbr_base = 16
N*
N* nbr = 0
N* pstr_next = "xGABCDE"
N*
N*
N* (d) Valid decimal parse string integer ('0x' prefix ignored
N* following invalid hexadecimal characters) :
N*
N* pstr = " 0xGABCDE"
N* nbr_base = 0
N*
N* nbr = 0
N* pstr_next = "xGABCDE"
N*
N*
N* (e) Valid decimal parse string integer ('0' prefix ignored
N* following invalid octal characters) :
N*
N* pstr = " 0GABCDE"
N* nbr_base = 0
N*
N* nbr = 0
N* pstr_next = "GABCDE"
N*
N*
N* (f) Parse string integer overflow :
N*
N* pstr = " 12345678901234567890*123456"
N* nbr_base = 10
N*
N* nbr = DEF_INT_32U_MAX_VAL
N* pstr_next = "*123456"
N*
N*
N* (g) Parse string integer underflow :
N*
N* pstr = " -12345678901234567890*123456"
N* nbr_base = 10
N*
N* nbr = DEF_INT_32S_MIN_VAL
N* pstr_next = "*123456"
N*
N*
N* (4) String parse terminates when :
N*
N* (a) Base passed an invalid base (see Note #2a1B1b).
N* (1) No conversion performed; 0 returned.
N*
N* (b) (1) Parse string passed a NULL pointer OR empty integer sequence (see Note #2a2A).
N* (A) No conversion performed; 0 returned.
N*
N* (2) Invalid parse string character found (see Note #2a1C).
N* (A) Parsed integer returned.
N* (B) 'pstr_next' points to invalid character.
N*
N* (3) Entire parse string converted (see Note #2a2B).
N* (A) Parsed integer returned.
N* (B) 'pstr_next' points to terminating NULL character.
N*
N* (5) Pointers to variables that return values MUST be initialized PRIOR to all other
N* validation or function handling in case of any error(s).
N*********************************************************************************************************
N*/
N/*$PAGE*/
Nstatic CPU_INT32U Str_ParseNbr_Int32 (const CPU_CHAR *pstr,
N CPU_CHAR **pstr_next,
N CPU_INT08U nbr_base,
N CPU_BOOLEAN nbr_signed,
N CPU_BOOLEAN *pnbr_neg)
N{
N const CPU_CHAR *pstr_parse;
N const CPU_CHAR *pstr_parse_nbr;
N CPU_CHAR *pstr_parse_unused;
N CPU_CHAR parse_char;
N CPU_INT08U parse_dig;
N CPU_INT32U nbr;
N CPU_BOOLEAN nbr_neg_unused;
N CPU_BOOLEAN nbr_dig;
N CPU_BOOLEAN nbr_alpha;
N CPU_BOOLEAN nbr_hex;
N CPU_BOOLEAN nbr_hex_lower;
N CPU_BOOLEAN whitespace;
N CPU_BOOLEAN neg;
N CPU_BOOLEAN ovf;
N CPU_BOOLEAN done;
N
N /* --------------- VALIDATE PARSE ARGS ---------------- */
N if (pstr_next == (CPU_CHAR **) 0) { /* If NOT avail, ... */
N pstr_next = (CPU_CHAR **)&pstr_parse_unused; /* ... re-cfg NULL rtn ptr to unused local var. */
N (void)&pstr_parse_unused; /* Prevent possible 'variable unused' warning. */
N }
N *pstr_next = (CPU_CHAR *)pstr; /* Init rtn str for err (see Note #5). */
N
N if (pnbr_neg == (CPU_BOOLEAN *) 0) { /* If NOT avail, ... */
N pnbr_neg = (CPU_BOOLEAN *)&nbr_neg_unused; /* ... re-cfg NULL rtn ptr to unused local var. */
N (void)&nbr_neg_unused; /* Prevent possible 'variable unused' warning. */
N }
N *pnbr_neg = DEF_NO; /* Init nbr neg for err (see Note #5). */
X *pnbr_neg = 0u;
N
N
N if (pstr == (CPU_CHAR *)0) { /* Rtn zero if str ptr NULL (see Note #4b1). */
N return (0u);
N }
N /* Rtn zero if invalid base (see Note #4a). */
N if ((nbr_base == 1u) ||
N (nbr_base > 36u)) {
N return (0u);
N }
N
N
N /* ------------- IGNORE PRECEDING CHAR(S) ------------- */
N pstr_parse = pstr; /* Save ptr to init'l str for err (see Note #2a2A2). */
N
N whitespace = ASCII_IsSpace(*pstr_parse);
N while (whitespace == DEF_YES) { /* Ignore initial white-space char(s) [see Note #2a1A]. */
X while (whitespace == 1u) {
N pstr_parse++;
N whitespace = ASCII_IsSpace(*pstr_parse);
N }
N
N switch (*pstr_parse) {
N case '+': /* Ignore pos sign (see Note #2a1B2). */
N pstr_parse++;
N neg = DEF_NO;
X neg = 0u;
N break;
N
N
N case '-': /* Validate neg sign (see Note #2a1B2a). */
N if (nbr_signed == DEF_YES) {
X if (nbr_signed == 1u) {
N pstr_parse++;
N }
N neg = DEF_YES;
X neg = 1u;
N break;
N
N
N default:
N neg = DEF_NO;
X neg = 0u;
N break;
N }
N
N
N/*$PAGE*/
N /* --------- IGNORE NBR BASE PRECEDING CHAR(S) -------- */
N pstr_parse_nbr = pstr_parse; /* Save ptr to str's nbr (see Note #2a1A1). */
N
N switch (nbr_base) {
N case 0u: /* Determine unspecified nbr base (see Notes #2a1B1a). */
N if (*pstr_parse == '0') { /* If avail, ... */
N pstr_parse++; /* ... adv past '0' prefix (see Note #2a1B1b2). */
N switch (*pstr_parse) {
N case 'x': /* For '0x' prefix, ... */
N case 'X':
N nbr_base = 16u; /* ... set nbr base = 16 (see Note #2a1B1a3). */
N parse_char = (CPU_CHAR)(*(pstr_parse + 1));
N nbr_hex = ASCII_IsDigHex(parse_char);
N if (nbr_hex == DEF_YES) { /* If next char is valid hex dig, ... */
X if (nbr_hex == 1u) {
N pstr_parse++; /* ... adv past '0x' prefix (see Note #2a1B1b2A). */
N }
N break;
N
N
N default: /* For '0' prefix, ... */
N nbr_base = 8u; /* ... set nbr base = 8 (see Note #2a1B1a2). */
N break;
N }
N
N } else { /* For non-'0' prefix, ... */
N nbr_base = 10u; /* ... set nbr base = 10 (see Note #2a1B1a1). */
N }
N break;
N
N
N case 8u: /* See Note #2a1B1a2. */
N if (*pstr_parse == '0') { /* If avail, ... */
N pstr_parse++; /* ... adv past '0' prefix (see Note #2a1B1b2B). */
N }
N break;
N
N
N case 16u: /* See Note #2a1B1a3. */
N if (*pstr_parse == '0') { /* If avail, ... */
N pstr_parse++; /* ... adv past '0' prefix (see Note #2a1B1b2). */
N switch (*pstr_parse) {
N case 'x':
N case 'X':
N parse_char = (CPU_CHAR)(*(pstr_parse + 1));
N nbr_hex = ASCII_IsDigHex(parse_char);
N if (nbr_hex == DEF_YES) { /* If next char is valid hex dig, ... */
X if (nbr_hex == 1u) {
N pstr_parse++; /* ... adv past '0x' prefix (see Note #2a1B1b2A). */
N }
N break;
N
N
N default:
N break;
N }
N }
N break;
N
N
N default: /* See Note #2a1B1b. */
N break;
N }
N
N
N/*$PAGE*/
N /* ------------------ PARSE INT STR ------------------- */
N nbr = 0u;
N ovf = DEF_NO;
X ovf = 0u;
N done = DEF_NO;
X done = 0u;
N
N while (done == DEF_NO) { /* Parse str for desired nbr base digs (see Note #2a2). */
X while (done == 0u) {
N parse_char = (CPU_CHAR)*pstr_parse;
N nbr_alpha = ASCII_IsAlphaNum(parse_char);
N if (nbr_alpha == DEF_YES) { /* If valid alpha num nbr dig avail, ... */
X if (nbr_alpha == 1u) {
N /* ... convert parse char into nbr dig. */
N nbr_dig = ASCII_IsDig(parse_char);
N if (nbr_dig == DEF_YES) {
X if (nbr_dig == 1u) {
N parse_dig = (CPU_INT08U)(parse_char - '0');
N } else {
N nbr_hex_lower = ASCII_IsLower(parse_char);
N if (nbr_hex_lower == DEF_YES) {
X if (nbr_hex_lower == 1u) {
N parse_dig = (CPU_INT08U)((parse_char - 'a') + 10u);
N } else {
N parse_dig = (CPU_INT08U)((parse_char - 'A') + 10u);
N }
N }
N
N if (parse_dig < nbr_base) { /* If parse char valid for nbr base ... */
N if (ovf == DEF_NO) { /* ... & nbr NOT yet ovf'd, ... */
X if (ovf == 0u) {
N if (nbr <= Str_MultOvfThTbl_Int32U[nbr_base]) {
N /* ... merge parse char dig into nbr. */
N nbr *= nbr_base;
N nbr += parse_dig;
N if (nbr < parse_dig) {
N ovf = DEF_YES;
X ovf = 1u;
N }
N } else {
N ovf = DEF_YES;
X ovf = 1u;
N }
N }
N pstr_parse++;
N
N } else { /* Invalid char parsed (see Note #2a1C1a). */
N done = DEF_YES;
X done = 1u;
N }
N
N } else { /* Invalid OR NULL char parsed (see Note #2a1C1). */
N done = DEF_YES;
X done = 1u;
N }
N }
N
N if (ovf == DEF_YES) { /* If nbr ovf'd, ... */
X if (ovf == 1u) {
N nbr = DEF_INT_32U_MAX_VAL; /* ... rtn max int val (see Note #2a3A1). */
X nbr = 4294967295u;
N }
N
N
N if (pstr_parse != pstr_parse_nbr) { /* If final parse str != init'l parse nbr str, .. */
N *pstr_next = (CPU_CHAR *)pstr_parse; /* .. rtn parse str's next char (see Note #2a2B2); .. */
N } else {
N *pstr_next = (CPU_CHAR *)pstr; /* .. else rtn initial parse str (see Note #2a2A2). */
N }
N
N *pnbr_neg = neg; /* Rtn neg nbr status. */
N
N
N return (nbr);
N}
N