aboutsummaryrefslogblamecommitdiffstats
path: root/libical/doc/UsingLibical.lyx
blob: b55cbb59095ba654982b6e17bbf76d21bc3f748d (plain) (tree)
1
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
                                                         















































                                                                           
                                                          

                   



       


































                   
                                                           




                                                                             



                                                          








                                                                         
                




                                                                   
                

                                  
                

























                                                                                
                
 
                                                           


                    





                                                                         













                                                                                
                







































                                                                                































































                                                                         

                  


                     
           
                     

           
                     

       
                     



                  







                                                                               
            
                     

     
                     

          
                     

            



                     

                 


                     




















                                                                               

                                                                        












                                                                           


















                                                                        















































































                                                                                
                




                                            
                

                
                



































                                                                               











                          


                                                 
                                        

            
                                        

            
                                                          

            
                                       

            

                                                           
 

                                                
 

                                        
 

                                       
 





                                                                                
 
















                                                                                

                







                                                                            
 






                                                                         




                     
 
                     
 
                     
            



                     
 
                     
 
                     
 
                     
 
                     
 
                     

                     
 
                     
                    



                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 


                          
 
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 
                     
 


                                         
 
 





































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































































                                                                                









































































































                                                                               
          





















                                                                                 
                                                                              














                                                  
#This file was created by <eric> Sat Feb 19 10:33:21 2000
#LyX 1.0 (C) 1995-1999 Matthias Ettrich and the LyX Team
\lyxformat 2.15
\textclass linuxdoc
\language default
\inputencoding default
\fontscheme default
\graphics default
\paperfontsize default
\spacing single 
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
\quotes_times 2
\papercolumns 1
\papersides 1
\paperpagestyle default

\layout Title

Using Libical
\layout Author

Eric Busboom (eric@softwarestudio.org)
\layout Date

January 2000
\layout Section

Introduction 
\layout Standard

Libical is an Open Source implementation of the iCalendar protocols and
 protocol data units.
 The iCalendar specification describes how calendar clients can communicate
 with calendar servers for users can store their calendar data and arrange
 meetings with other users.
 
\layout Standard

Libical implements the following specifications and protocols
\layout Standard
\added_space_top 0.3cm \added_space_bottom 0.3cm \LyXTable
multicol5
5 2 0 0 -1 -1 -1 -1
1 0 0 0
1 0 0 0
1 0 0 0
1 0 0 0
1 1 0 0
8 1 0 "" ""
8 1 1 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""
0 8 1 0 0 0 0 "" ""

iCal Core
\newline 
2445
\newline 
iTIP
\newline 
2446
\newline 
iMIP
\newline 
2447
\newline 
iRIP
\newline 
draft
\newline 
CAP
\newline 
draft
\layout Standard

(The current version, 0.15, does not implement iRip or CAP.
 ) 
\layout Standard

This documentation assumes that you are familiar with the iCalendar standards
 RFC2445 and RFC2446.
 these specifications are online on the CALSCH webpage at:
\layout Verbatim

http://www.imc.org/ietf-calendar/
\layout Subsection

The libical project
\layout Standard

This code is under active development.
 If you would like to contribute to the project, you can contact me, Eric
 Busboom, at eric@softwarestudio.org.
 The project has a webpage at
\layout Verbatim

http://softwarestudio.org/libical/index.html 
\layout Standard

and a mailing list that you can join by sending the following mail:
\layout Verbatim

To: minimalist@softwarestudio.org 
\layout Verbatim

Subject: subscribe libical 
\layout Subsection

License
\layout Standard

The code and datafiles in this distribution are licensed under the Mozilla
 Public License.
 See http://www.mozilla.org/NPL/MPL-1.0.html for a copy of the license.
 Alternately, you may use libical under the terms of the GNU Library General
 Public License.
 See http://www.fsf.org/copyleft/lesser.html for a copy of the LGPL.
\layout Standard

This dual license ensures that the library can be incorporated into both
 proprietary code and GPL'd programs, and will benefit from improvements
 made by programmers in both realms.
 I will only accept changes into my version of the library if they are similarly
 dual-licensed.
\layout Subsection

Purpose & Goals 
\layout Subsection

Document version
\layout Verbatim

$Id: UsingLibical.lyx,v 1.2 2000/04/18 18:17:03 alves Exp $
\layout Section

Building the Library
\layout Standard

Libical uses autoconf to generate makefiles, although it uses none of the
 autoconf flags to influence the compilation.
 It should built with no adjustments on Linux, FreeBSD and Solaris.
 
\layout Section

Structure 
\layout Standard

The iCal calendar model is based on four types of objects: components, propertie
s, values and parameters.
 
\layout Standard

Properties are the fundamental unit of information in iCal, and they work
 a bit like a hash entry, with a constant key and a variable value.
 Properties may also have modifiers, called parameters.
 In the iCal content line
\layout Verbatim

ORGANIZER;ROLE=CHAIR:MAILTO:mrbig@host.com
\layout Standard

The property name is 
\begin_inset Quotes eld
\end_inset 

ORGANIZER,
\begin_inset Quotes erd
\end_inset 

 the value of the property is 
\begin_inset Quotes eld
\end_inset 

mrbig@host.com
\begin_inset Quotes erd
\end_inset 

 and the 
\begin_inset Quotes eld
\end_inset 

ROLE
\begin_inset Quotes erd
\end_inset 

 parameter specifies that Mr Big is the chair of the meetings associated
 with this property.
 
\layout Standard

Components are groups of properties that represent the core objects of a
 calendar system, such as events or timezones.
 
\layout Standard

The central goal of libical is to parse iTIP data into an internal representatio
n of Components, Properties, Parameters an Values, and to allow the user
 to manipulate the data in various ways 
\layout Standard
\added_space_bottom 0.3cm 
\begin_float fig 
\layout Standard


\begin_inset Figure size 180 147
file icaluml.eps
flags 13

\end_inset 


\end_float 
When a component is send across a network, if it is un-encrypted, it will
 look something like:
\layout Code

BEGIN:VEVENT 
\layout Code

DTSTAMP:19980309T231000Z 
\layout Code

UID:guid-1.host1.com 
\layout Code

ORGANIZER;ROLE=CHAIR:MAILTO:mrbig@host.com 
\layout Code

ATTENDEE;RSVP=TRUE;ROLE=REQ-PARTICIPANT;CUTYPE=GROUP: 
\layout Code


\protected_separator 
 MAILTO:employee-A@host.com 
\layout Code

DESCRIPTION:Project XYZ Review Meeting 
\layout Code

CATEGORIES:MEETING 
\layout Code

CLASS:PUBLIC 
\layout Code

CREATED:19980309T130000Z 
\layout Code

SUMMARY:XYZ Project Review 
\layout Code

DTSTART;TZID=US-Eastern:19980312T083000 
\layout Code

DTEND;TZID=US-Eastern:19980312T093000 
\layout Code

LOCATION:1CP Conference Room 4350 
\layout Code

END:VEVENT 
\layout Subsection

Core iCal classes
\layout Subsubsection

Components 
\layout Subsubsection

Properties 
\layout Subsubsection

Values 
\layout Subsubsection

Parameters 
\layout Subsection

Other elements of libical
\layout Standard

In addition to the core iCal classes, libical has many other types, structures,
 classes that aid in creating and using iCal components.
 
\layout Subsubsection

Enumerations
\layout Subsubsection

Types
\layout Subsubsection

The Parser
\layout Subsubsection

Restrictions
\layout Subsubsection

Error objects
\layout Subsubsection

Memory Management
\layout Subsubsection

Storage classes
\layout Section

Differences From RFCs 
\layout Standard

Libical has been designed to follow the standards as closely as possible,
 so that the key objects in the standards are also keey objects in the library.
 However, there are a few areas where the specifications are (arguably)
 irregular, and following them exactly would result in an unfriendly interface.
 These deviations make libical easier to use by maintaining a self-similar
 interface.
 
\layout Subsection

Pseudo Components 
\layout Standard

Libical defines components for groups of properties that look and act like
 components, but are not defined as components in the specification.
 XDAYLIGHT and XSTANDARD are notable examples.
 These pseudo components group properties within the VTIMEZONE components.
 For instanace, the timezone properties associated with daylight savings
 time starts with 
\begin_inset Quotes eld
\end_inset 

BEGIN:DAYLIGHT
\begin_inset Quotes erd
\end_inset 

 and ends with 
\begin_inset Quotes eld
\end_inset 

END:DAYLIGHT, just like other components, but is not defined as a component
 in RFC2445.
 ( See RFC2445, page 61 ) In Libical,this grouping is represented by the
 XDAYLIGHT component.
 Standard iCAL components all start with the letter 
\begin_inset Quotes eld
\end_inset 

V,
\begin_inset Quotes erd
\end_inset 

 while pseudo components start with
\begin_inset Quotes erd
\end_inset 

X.
\begin_inset Quotes erd
\end_inset 


\layout Standard

There are also pseudo components that are conceptually derived classess
 of VALARM.
 RFC2446 defines what properties may be included in each component, and
 for VALARM, the set of properties it may have depends on the value of the
 ACTION property.
 
\layout Standard

For instance, if a VALARM component has an ACTION property with the value
 of 
\begin_inset Quotes eld
\end_inset 

AUDIO,
\begin_inset Quotes erd
\end_inset 

 the component must also have an 
\begin_inset Quotes eld
\end_inset 

ATTACH
\begin_inset Quotes erd
\end_inset 

 property.
 However, if the ACTION value is 
\begin_inset Quotes eld
\end_inset 

DISPLAY,
\begin_inset Quotes erd
\end_inset 

 the component must have a DESCRIPTION property.
 
\layout Standard

To handle these various, complex restrictions, libical has pseudo components
 for each type of alarm: XAUDIOALARM, XDISPLAYALARM, XEMAILALARM and XPROCEDUREA
LARM.
 
\layout Subsection

Combined Values 
\layout Standard

Many values can take more than one type.
 TRIGGER, for instance, can have a value type of with DURATION or of DATE-TIME.
 These multiple types make it difficult to create routines to return the
 value associated with a property.
 
\layout Standard

It is natural to have interfaces that would return the value of a property,
 but it is cumbersone for a single routine to return multiple types.
 So, in libical, properties that can have multiple types are given a single
 type that is the union of their RFC2445 types.
 For instance, in libical, the value of the TRIGGER property resolves to
 
\noun on 
struct icaltriggertype
\noun default 
.
 This type is a union of a DURATION and a DATE-TIME.
 
\layout Subsection

Multi-Valued Properties
\layout Standard

Some properties, such as CATEGORIES have only one value type, but each CATEGORIE
S property can have multiple value instances.
 This also results in a cumbersome interface -- CATEGORIES accessors would
 have to return a list while all other accessors returned a single value.
 In libical, all properties have a single value, and multi-valued properties
 are broken down into multiple single valued properties during parsing.
 That is, an input line like, 
\layout Verbatim

CATEGORIES: work, home
\layout Standard

becomes in libical's internal representation
\layout Verbatim

CATEGORIES: work
\layout Verbatim

CATEGORIES: home
\layout Standard

Oddly, RFC2445 allows some multi-valued properties ( like FREEBUSY ) to
 exist as both a multi-values property and as multiple single value properties,
 while others ( like CATEGORIES ) can only exist as single multi-valued
 properties.
 This makes the internal representation for CATEGORIES illegal.
 However when you convert a component to a string, the library will collect
 all of the CATEGORIES properties into one.
 
\layout Section

Implementation Limitations 
\layout Section

Using libical
\layout Subsection

Creating Components 
\layout Standard

There are three ways to create components in Libical: creating individual
 objects and assembling them, building entire objects in massive vaargs
 calls, and parsing a text file containing iCalendar data.
 
\layout Subsubsection

Constructor Interfaces 
\layout Standard

Using constructor interfaces, you create each of the objects seperately
 and them assemble them in to components: 
\layout Code

icalcomponent *event;
\layout Code

icalproperty *prop;
\layout Code

icalparameter *param;
\layout Code

struct icaltimetype atime;
\layout Code

event = icalcomponent_new(ICAL_VEVENT_COMPONENT);
\layout Code

prop = icalproperty_new_dtstamp(atime) ;
\layout Code

icalcomponent_add_property(event, prop);
\layout Code

prop = icalproperty_new_uid(strdup("guid-1.host1.com")) );
\layout Code

icalcomponent_add_property(event,prop);
\layout Code

prop=icalproperty_new_organizer(strdup("mrbig@host.com")); 
\layout Code

param = icalparameter_new_role(ICAL_ROLE_CHAIR) 
\layout Code

icalproperty_add_parameter(prop, param);
\layout Code

icalcomponent_add_property(event,prop);
\layout Standard

While we are on this example, you should notice that libical uses a semi-object-
oriented style of interface.
 Most things you work with are objects, that are instantiated with a constructor
 that has 
\begin_inset Quotes eld
\end_inset 

new
\begin_inset Quotes erd
\end_inset 

 in the name.
 Also note that, other than the object reference, most structure data is
 passed in to libical routines by value.
 Strings, of course, are passed in by reference, but libical will take ownership
 of the memory, so you had beter strdup() the data unless you want a core
 dump when the memory is freed for the second time.
 Libical has some complex bu very regular memory handling rules.
 These are detailed in section 
\begin_inset LatexCommand \ref{sec:memory}

\end_inset 

.
\layout Standard

If any of the constructors fail, they will return 0.
 If you try to insert 0 into a property or component, or use a zero-valued
 object reference, libical will either silently ignore the error or will
 abort with an error message.
 This behavior is controlled by a compile time flag (ICAL_ERRORS_ARE_FATAL),
 and will abort by default.
 
\layout Subsubsection

vaargs Constructors 
\layout Standard

There is another way to create complex components, which is arguable more
 elegant, if you are not horrified by vaargs.
 The vaargs constructor interface all you to create intricate components
 in a single block of text.
 
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 
 calendar = 
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalcomponent_vanew(
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 ICAL_VCALENDAR_COMPONENT,
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 icalproperty_new_version(strdup("2.0")),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 icalproperty_new_prodid(strdup("-//RDU Software//NONSGML HandCal//EN")),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 icalcomponent_vanew(
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
ICAL_VEVENT_COMPONENT,
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalproperty_new_dtstamp(atime),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalproperty_new_uid(strdup("guid-1.host1.com")),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalproperty_vanew_organizer(
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 strdup("mrbig@host.com"),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 icalparameter_new_role(ICAL_ROLE_CHAIR),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 0
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalproperty_vanew_attendee(
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 strdup("employee-A@host.com"),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 icalparameter_new_role(ICAL_ROLE_REQPARTICIPANT),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 icalparameter_new_rsvp(1),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 icalparameter_new_cutype(ICAL_CUTYPE_GROUP),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 0
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 ),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalproperty_new_location(strdup("1CP Conference Room 4350")),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
0
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
),
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 0
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
 );
\layout Standard

This form is similar to the regular constructor, except that they have 
\begin_inset Quotes eld
\end_inset 

vanew
\begin_inset Quotes erd
\end_inset 

 instead of 
\begin_inset Quotes eld
\end_inset 

new
\begin_inset Quotes erd
\end_inset 

 in the name.
 The arguments are similar too, except that the component contstructor can
 have a list of properties, and the property constructor can have a list
 or parameters.
 Be sure to terminate every list with a '0', or your code will crash, if
 you are lucky.
 
\layout Subsubsection

Parsing Text Files 
\layout Standard

The final way to create components will probably be the most common; you
 can create components from RFC2445 compliant text.
 If you have the string in memory, use
\layout Verbatim

icalcomponent* icalparser_parse_string(char* str);
\layout Standard

This may seem wasteful if you want to pull a large component off of the
 network; you may prefer to parse the component line by line.
 This is possible too, with 
\layout Verbatim

icalcomponent* icalparser_parse(char*(*line_gen_func)(char *s, size_t size,
 void *d));
\layout Standard

This routine takes a pointer to a function that copies 'size' characters
 to 's'.
 The routine returns 's', similar to fgets().
 See string_line_generator in icalparser.c for an example.
 
\layout Subsection

Accessing Components 
\layout Standard

Given a reference to a component, you probably will want to access the propertie
s, parameters and values inside.
 
\layout Subsubsection

Finding Components 
\layout Standard

To find a sub-component of a component, use: 
\layout Verbatim

icalproperty* icalcomponent_get_first_component(
\layout Verbatim


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalcomponent* component, 
\layout Verbatim


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
icalcomponent_kind kind);
\layout Standard

This routine will return a reference to the first component of the type
 'kind.' The key kind values, listed in icalenums.h are: 
\layout Code

ICAL_ANY_COMPONENT
\layout Code

ICAL_VEVENT_COMPONENT
\layout Code

ICAL_VTODO_COMPONENT
\layout Code

ICAL_VJOURNAL_COMPONENT
\layout Code

ICAL_VCALENDAR_COMPONENT 
\layout Code

ICAL_VFREEBUSY_COMPONENT
\layout Code

ICAL_VALARM_COMPONENT
\layout Standard

These are only the most common components; there are many more listed in
 icalenums.h.
\layout Standard

As you might guess, if there is more than one subcomponent of the type you
 have chosen, this routine will return only the first.
 to get at the others, you need to iterate through the component.
 
\layout Subsubsection

Interating Through Components
\layout Standard

Iteration requires a second routine to get the next subcomponent after the
 first:
\layout Verbatim

icalcomponent* icalcomponent_get_next_component(icalcomponent* component,
 
\layout Verbatim

icalcomponent_kind kind);
\layout Standard

With the 'first' and 'next' routines, you can create a for loop to iterate
 through all of a components subcomponents
\layout Code


\protected_separator 
 for(c = icalcomponent_get_first_component(comp,ICAL_ANY_COMPONENT); 
\layout Code


\protected_separator 
 
\protected_separator 
 
\protected_separator 
 
\protected_separator 
 
\protected_separator 
c != 0; 
\layout Code


\protected_separator 
 
\protected_separator 
 
\protected_separator 
 
\protected_separator 
 
\protected_separator 
c = icalcomponent_get_next_component(comp,ICAL_ANY_COMPONENT))
\layout Code

{ 
\layout Code


\protected_separator 
 
\protected_separator 
 
\protected_separator 
 do_something(c);
\layout Code

}
\layout Standard

This code bit wil iterate through all of the subcomponents in 'comp' but
 you can select a specific type of component by changing ICAL_ANY_COMPONENT
 to another component type.
\layout Subsubsection

Removing Components 
\layout Standard

Libical component have internal iterators, so you can only have one iteration
 over a component at a time.
 Removing an element from a list while iterating through the list can cause
 problems, since you will probably be removing the element that the internal
 iterator points to.
 This will result in the iteration loop terminating immediately after removing
 the element.
 To avoid the problem, you will need to step the iterator ahead of the element
 you are going to remove, like this:
\layout Code

for(c = icalcomponent_get_first_component(parent_comp,ICAL_ANY_COMPONENT);
 
\layout Code


\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 

\protected_separator 
c != 0; 
\layout Code


\protected_separator 
 
\protected_separator 
 
\protected_separator 
 
\protected_separator 
c = next
\layout Code

{ 
\protected_separator 
 
\protected_separator 
 
\layout Code


\protected_separator 
next = icalcomponent_get_next_component(parent_comp,ICAL_ANY_COMPONENT);
\layout Code


\protected_separator 
 
\protected_separator 
 icalcomponent_remove_component(parent_comp,c); 
\layout Code

}
\layout Subsubsection

Working with properties and parameters
\layout Standard

Finding, iterating and removing properties works the same as it does for
 components, using the property-specific or parameter-specific interfaces:
 
\layout Verbatim

icalproperty* icalcomponent_get_first_property(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalcomponent* component, 
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty_kind kind); 
\layout Verbatim

icalproperty* icalcomponent_get_next_property(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalcomponent* component, 
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty_kind kind);
\layout Verbatim

void icalcomponent_add_property(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalcomponent* component, 
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty* property);
\layout Verbatim

void icalcomponent_remove_property(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalcomponent* component, 
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty* property);
\layout Verbatim

icalparameter* icalproperty_get_first_parameter(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty* prop, 
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalparameter_kind kind); 
\layout Verbatim

icalparameter* icalproperty_get_next_parameter(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty* prop, 
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalparameter_kind kind);
\layout Verbatim

void icalproperty_add_parameter(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty* prop,
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalparameter* parameter);
\layout Verbatim

void icalproperty_remove_parameter(
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalproperty* prop, 
\layout Verbatim


\protected_separator 
 
\protected_separator 
 
\protected_separator 
icalparameter_kind kind);
\layout Subsubsection

Getting Values 
\layout Subsubsection

Setting Values 
\layout Subsubsection

Getting Parameters
\layout Subsubsection

Setting Parameters 
\layout Subsubsection

Removing Parameters 
\layout Subsubsection

Checking Component Validity
\layout Subsection

Storing Objects
\layout Standard

The libical distribution inclues a seperate library, libicalss, that allows
 you to store iCal component data to disk in a variety of ways.
 This library is documented seperately.
 
\layout Subsection


\begin_inset LatexCommand \label{sec:memory}

\end_inset 

Memory Management 
\layout Standard

Libical relies heavily on dynamic allocation for both the core objects and
 for the strings used to hold values.
 Some of this memory the library caller owns and must free, and some of
 the memory is managed by the library.
 Here is a summary of the memory rules.
 
\layout Description

1) If the function name has "new" in it, the caller gets control of the
 memory.
 ( such as icalcomponent_new(), or icalproperty_new_clone() ) 
\layout Description

2) If you got the memory from a routine with new in it, you must call the
 corresponding *_free routine to free the memory.
 ( Use icalcomponent_free() to free objects created with icalcomponent_new())
 
\layout Description

3) If the function name has "add" in it, the caller is transfering control
 of the memory to the routine.
 ( icalproperty_add_parameter() )
\layout Description

4) If the function name has "remove" in it, the caller passes in a pointer
 to an object and after the call returns, the caller owns the object.
 So, before you call icalcomponent_remove_property(comp,foo), you do not
 own "foo" and after the call returns, you do.
 
\layout Description

5) If the routine returns a string, libical owns the memory and will put
 it on a ring buffer to reclaim later.
 You'd better strdup() it if you want to keep it, and you don't have to
 delete it.
 
\layout Subsection

Error Handling
\layout Standard

icalerror_errno.
 Return values.
 #defines.
 icalerror_stop_here.
 X-LIC-ERROR
\layout Subsubsection

Return values
\layout Subsubsection

icalerrno
\layout Subsubsection

Component errors
\layout Subsubsection

icalerror_stop_here
\layout Subsubsection

X-LIC-ERROR
\layout Subsection

Naming Standard
\layout Standard

Structures that you access with the 
\begin_inset Quotes eld
\end_inset 

struct
\begin_inset Quotes erd
\end_inset 

 keyword, such as 
\begin_inset Quotes eld
\end_inset 

struct icaltimetype
\begin_inset Quotes erd
\end_inset 

 are things that you are allowed to see inside and poke at.
 
\layout Standard

Structures that you access though a typedef, such as 
\begin_inset Quotes eld
\end_inset 

icalcomponent
\begin_inset Quotes erd
\end_inset 

 are things where all of the data is hidden.
 
\layout Standard

Component names that start with 
\begin_inset Quotes eld
\end_inset 

V
\begin_inset Quotes erd
\end_inset 

 are part of RFC 2445 or another iCal standard.
 Component names that start with 
\begin_inset Quotes eld
\end_inset 

X
\begin_inset Quotes erd
\end_inset 

 are also part of the spec, but they are not actually components in the
 spec.
 However, they look and act like components, so they are components in libical.
 Names that start with 
\begin_inset Quotes eld
\end_inset 

XLIC
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset Quotes eld
\end_inset 

X-LIC
\begin_inset Quotes erd
\end_inset 

 are not part of any iCal spec.
 They are used internally by libical.
 
\layout Standard

Enums that identify a component, property, value or parameter end with 
\begin_inset Quotes eld
\end_inset 

_COMPONENT,
\begin_inset Quotes erd
\end_inset 

 
\begin_inset Quotes eld
\end_inset 

_PROPERTY,
\begin_inset Quotes erd
\end_inset 

 
\begin_inset Quotes eld
\end_inset 

_VALUE,
\begin_inset Quotes erd
\end_inset 

 or 
\begin_inset Quotes eld
\end_inset 

_PARAMETER
\begin_inset Quotes erd
\end_inset 

s
\layout Standard

Enums that identify a parameter value have the name of the parameter as
 the second word.
 For instance: ICAL_ROLE_REQPARTICIPANT or ICAL_PARTSTAT_ACCEPTED.
\layout Standard

The enums for the parts of a recurarance rule and request statuses are irregular.
 
\layout Section

Useful Recipies
\layout Standard

Iteration
\layout Standard

Copying components.
 Remember that you must clone or remove an object before putting in on another
 list.
 
\layout Standard

Finding compliance errors
\layout Section

Performance
\layout Standard

Checking restrictions is computationally expensive
\layout Section

Hacks and Bugs
\the_end