/usr/include/exiv2/value.hpp is in libexiv2-dev 0.25-3.1+deb9u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // ***************************************************************** -*- C++ -*-
/*
* Copyright (C) 2004-2015 Andreas Huggel <ahuggel@gmx.net>
*
* This program is part of the Exiv2 distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
*/
/*!
@file value.hpp
@brief Value interface and concrete subclasses
@version $Rev: 3090 $
@author Andreas Huggel (ahu)
<a href="mailto:ahuggel@gmx.net">ahuggel@gmx.net</a>
@date 09-Jan-04, ahu: created
11-Feb-04, ahu: isolated as a component
31-Jul-04, brad: added Time, Data and String values
*/
#ifndef VALUE_HPP_
#define VALUE_HPP_
// *****************************************************************************
// included header files
#include "types.hpp"
// + standard includes
#include <string>
#include <vector>
#include <map>
#include <iostream>
#include <iomanip>
#include <sstream>
#include <memory>
#include <cstring>
// *****************************************************************************
// namespace extensions
namespace Exiv2 {
// *****************************************************************************
// class definitions
/*!
@brief Common interface for all types of values used with metadata.
The interface provides a uniform way to access values independent of
their actual C++ type for simple tasks like reading the values from a
string or data buffer. For other tasks, like modifying values you may
need to downcast it to a specific subclass to access its interface.
*/
class EXIV2API Value {
public:
//! Shortcut for a %Value auto pointer.
typedef std::auto_ptr<Value> AutoPtr;
//! @name Creators
//@{
//! Constructor, taking a type id to initialize the base class with
explicit Value(TypeId typeId);
//! Virtual destructor.
virtual ~Value();
//@}
//! @name Manipulators
//@{
/*!
@brief Read the value from a character buffer.
@param buf Pointer to the data buffer to read from
@param len Number of bytes in the data buffer
@param byteOrder Applicable byte order (little or big endian).
@return 0 if successful.
*/
virtual int read(const byte* buf, long len, ByteOrder byteOrder) =0;
/*!
@brief Set the value from a string buffer. The format of the string
corresponds to that of the write() method, i.e., a string
obtained through the write() method can be read by this
function.
@param buf The string to read from.
@return 0 if successful.
*/
virtual int read(const std::string& buf) =0;
/*!
@brief Set the data area, if the value has one by copying (cloning)
the buffer pointed to by buf.
Values may have a data area, which can contain additional
information besides the actual value. This method is used to set such
a data area.
@param buf Pointer to the source data area
@param len Size of the data area
@return Return -1 if the value has no data area, else 0.
*/
virtual int setDataArea(const byte* buf, long len);
//@}
//! @name Accessors
//@{
//! Return the type identifier (Exif data format type).
TypeId typeId() const { return type_; }
/*!
@brief Return an auto-pointer to a copy of itself (deep copy).
The caller owns this copy and the auto-pointer ensures that
it will be deleted.
*/
AutoPtr clone() const { return AutoPtr(clone_()); }
/*!
@brief Write value to a data buffer.
The user must ensure that the buffer has enough memory. Otherwise
the call results in undefined behaviour.
@param buf Data buffer to write to.
@param byteOrder Applicable byte order (little or big endian).
@return Number of bytes written.
*/
virtual long copy(byte* buf, ByteOrder byteOrder) const =0;
//! Return the number of components of the value
virtual long count() const =0;
//! Return the size of the value in bytes
virtual long size() const =0;
/*!
@brief Write the value to an output stream. You do not usually have
to use this function; it is used for the implementation of
the output operator for %Value,
operator<<(std::ostream &os, const Value &value).
*/
virtual std::ostream& write(std::ostream& os) const =0;
/*!
@brief Return the value as a string. Implemented in terms of
write(std::ostream& os) const of the concrete class.
*/
std::string toString() const;
/*!
@brief Return the <EM>n</EM>-th component of the value as a string.
The default implementation returns toString(). The behaviour
of this method may be undefined if there is no <EM>n</EM>-th
component.
*/
virtual std::string toString(long n) const;
/*!
@brief Convert the <EM>n</EM>-th component of the value to a long.
The behaviour of this method may be undefined if there is no
<EM>n</EM>-th component.
@return The converted value.
*/
virtual long toLong(long n =0) const =0;
/*!
@brief Convert the <EM>n</EM>-th component of the value to a float.
The behaviour of this method may be undefined if there is no
<EM>n</EM>-th component.
@return The converted value.
*/
virtual float toFloat(long n =0) const =0;
/*!
@brief Convert the <EM>n</EM>-th component of the value to a Rational.
The behaviour of this method may be undefined if there is no
<EM>n</EM>-th component.
@return The converted value.
*/
virtual Rational toRational(long n =0) const =0;
//! Return the size of the data area, 0 if there is none.
virtual long sizeDataArea() const;
/*!
@brief Return a copy of the data area if the value has one. The
caller owns this copy and DataBuf ensures that it will be
deleted.
Values may have a data area, which can contain additional
information besides the actual value. This method is used to access
such a data area.
@return A DataBuf containing a copy of the data area or an empty
DataBuf if the value does not have a data area assigned.
*/
virtual DataBuf dataArea() const;
/*!
@brief Check the \em ok status indicator. After a to<Type> conversion,
this indicator shows whether the conversion was successful.
*/
bool ok() const { return ok_; }
//@}
/*!
@brief A (simple) factory to create a Value type.
The following Value subclasses are created depending on typeId:<BR><BR>
<TABLE>
<TR><TD class="indexkey"><B>typeId</B></TD><TD class="indexvalue"><B>%Value subclass</B></TD></TR>
<TR><TD class="indexkey">invalidTypeId</TD><TD class="indexvalue">%DataValue(invalidTypeId)</TD></TR>
<TR><TD class="indexkey">unsignedByte</TD><TD class="indexvalue">%DataValue(unsignedByte)</TD></TR>
<TR><TD class="indexkey">asciiString</TD><TD class="indexvalue">%AsciiValue</TD></TR>
<TR><TD class="indexkey">string</TD><TD class="indexvalue">%StringValue</TD></TR>
<TR><TD class="indexkey">unsignedShort</TD><TD class="indexvalue">%ValueType < uint16_t ></TD></TR>
<TR><TD class="indexkey">unsignedLong</TD><TD class="indexvalue">%ValueType < uint32_t ></TD></TR>
<TR><TD class="indexkey">unsignedRational</TD><TD class="indexvalue">%ValueType < URational ></TD></TR>
<TR><TD class="indexkey">invalid6</TD><TD class="indexvalue">%DataValue(invalid6)</TD></TR>
<TR><TD class="indexkey">undefined</TD><TD class="indexvalue">%DataValue</TD></TR>
<TR><TD class="indexkey">signedShort</TD><TD class="indexvalue">%ValueType < int16_t ></TD></TR>
<TR><TD class="indexkey">signedLong</TD><TD class="indexvalue">%ValueType < int32_t ></TD></TR>
<TR><TD class="indexkey">signedRational</TD><TD class="indexvalue">%ValueType < Rational ></TD></TR>
<TR><TD class="indexkey">tiffFloat</TD><TD class="indexvalue">%ValueType < float ></TD></TR>
<TR><TD class="indexkey">tiffDouble</TD><TD class="indexvalue">%ValueType < double ></TD></TR>
<TR><TD class="indexkey">tiffIfd</TD><TD class="indexvalue">%ValueType < uint32_t ></TD></TR>
<TR><TD class="indexkey">date</TD><TD class="indexvalue">%DateValue</TD></TR>
<TR><TD class="indexkey">time</TD><TD class="indexvalue">%TimeValue</TD></TR>
<TR><TD class="indexkey">comment</TD><TD class="indexvalue">%CommentValue</TD></TR>
<TR><TD class="indexkey">xmpText</TD><TD class="indexvalue">%XmpTextValue</TD></TR>
<TR><TD class="indexkey">xmpBag</TD><TD class="indexvalue">%XmpArrayValue</TD></TR>
<TR><TD class="indexkey">xmpSeq</TD><TD class="indexvalue">%XmpArrayValue</TD></TR>
<TR><TD class="indexkey">xmpAlt</TD><TD class="indexvalue">%XmpArrayValue</TD></TR>
<TR><TD class="indexkey">langAlt</TD><TD class="indexvalue">%LangAltValue</TD></TR>
<TR><TD class="indexkey"><EM>default:</EM></TD><TD class="indexvalue">%DataValue(typeId)</TD></TR>
</TABLE>
@param typeId Type of the value.
@return Auto-pointer to the newly created Value. The caller owns this
copy and the auto-pointer ensures that it will be deleted.
*/
static AutoPtr create(TypeId typeId);
protected:
/*!
@brief Assignment operator. Protected so that it can only be used
by subclasses but not directly.
*/
Value& operator=(const Value& rhs);
// DATA
mutable bool ok_; //!< Indicates the status of the previous to<Type> conversion
private:
//! Internal virtual copy constructor.
virtual Value* clone_() const =0;
// DATA
TypeId type_; //!< Type of the data
}; // class Value
//! Output operator for Value types
inline std::ostream& operator<<(std::ostream& os, const Value& value)
{
return value.write(os);
}
//! %Value for an undefined data type.
class EXIV2API DataValue : public Value {
public:
//! Shortcut for a %DataValue auto pointer.
typedef std::auto_ptr<DataValue> AutoPtr;
//! @name Creators
//@{
//! Default constructor.
explicit DataValue(TypeId typeId =undefined);
//! Constructor
DataValue(const byte* buf,
long len, ByteOrder byteOrder =invalidByteOrder,
TypeId typeId =undefined);
//! Virtual destructor.
virtual ~DataValue();
//@}
//! @name Manipulators
//@{
/*!
@brief Read the value from a character buffer.
@note The byte order is required by the interface but not
used by this method, so just use the default.
@param buf Pointer to the data buffer to read from
@param len Number of bytes in the data buffer
@param byteOrder Byte order. Not needed.
@return 0 if successful.
*/
virtual int read(const byte* buf,
long len,
ByteOrder byteOrder =invalidByteOrder);
//! Set the data from a string of integer values (e.g., "0 1 2 3")
virtual int read(const std::string& buf);
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
/*!
@brief Write value to a character data buffer.
@note The byte order is required by the interface but not used by this
method, so just use the default.
The user must ensure that the buffer has enough memory. Otherwise
the call results in undefined behaviour.
@param buf Data buffer to write to.
@param byteOrder Byte order. Not needed.
@return Number of characters written.
*/
virtual long copy(byte* buf, ByteOrder byteOrder =invalidByteOrder) const;
virtual long count() const;
virtual long size() const;
virtual std::ostream& write(std::ostream& os) const;
/*!
@brief Return the <EM>n</EM>-th component of the value as a string.
The behaviour of this method may be undefined if there is no
<EM>n</EM>-th component.
*/
virtual std::string toString(long n) const;
virtual long toLong(long n =0) const;
virtual float toFloat(long n =0) const;
virtual Rational toRational(long n =0) const;
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual DataValue* clone_() const;
public:
//! Type used to store the data.
typedef std::vector<byte> ValueType;
// DATA
ValueType value_; //!< Stores the data value
}; // class DataValue
/*!
@brief Abstract base class for a string based %Value type.
Uses a std::string to store the value and implements defaults for
most operations.
*/
class EXIV2API StringValueBase : public Value {
public:
//! Shortcut for a %StringValueBase auto pointer.
typedef std::auto_ptr<StringValueBase> AutoPtr;
//! @name Creators
//@{
//! Constructor for subclasses
explicit StringValueBase(TypeId typeId);
//! Constructor for subclasses
StringValueBase(TypeId typeId, const std::string& buf);
//! Copy constructor
StringValueBase(const StringValueBase& rhs);
//! Virtual destructor.
virtual ~StringValueBase();
//@}
//! @name Manipulators
//@{
//! Read the value from buf. This default implementation uses buf as it is.
virtual int read(const std::string& buf);
/*!
@brief Read the value from a character buffer.
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Pointer to the data buffer to read from
@param len Number of bytes in the data buffer
@param byteOrder Byte order. Not needed.
@return 0 if successful.
*/
virtual int read(const byte* buf,
long len,
ByteOrder byteOrder =invalidByteOrder);
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
/*!
@brief Write value to a character data buffer.
The user must ensure that the buffer has enough memory. Otherwise
the call results in undefined behaviour.
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Data buffer to write to.
@param byteOrder Byte order. Not used.
@return Number of characters written.
*/
virtual long copy(byte* buf, ByteOrder byteOrder =invalidByteOrder) const;
virtual long count() const;
virtual long size() const;
virtual long toLong(long n =0) const;
virtual float toFloat(long n =0) const;
virtual Rational toRational(long n =0) const;
virtual std::ostream& write(std::ostream& os) const;
//@}
protected:
//! Assignment operator.
StringValueBase& operator=(const StringValueBase& rhs);
//! Internal virtual copy constructor.
virtual StringValueBase* clone_() const =0;
public:
// DATA
std::string value_; //!< Stores the string value.
}; // class StringValueBase
/*!
@brief %Value for string type.
This can be a plain Ascii string or a multipe byte encoded string. It is
left to caller to decode and encode the string to and from readable
text if that is required.
*/
class EXIV2API StringValue : public StringValueBase {
public:
//! Shortcut for a %StringValue auto pointer.
typedef std::auto_ptr<StringValue> AutoPtr;
//! @name Creators
//@{
//! Default constructor.
StringValue();
//! Constructor
explicit StringValue(const std::string& buf);
//! Virtual destructor.
virtual ~StringValue();
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual StringValue* clone_() const;
}; // class StringValue
/*!
@brief %Value for an Ascii string type.
This class is for null terminated single byte Ascii strings.
This class also ensures that the string is null terminated.
*/
class EXIV2API AsciiValue : public StringValueBase {
public:
//! Shortcut for a %AsciiValue auto pointer.
typedef std::auto_ptr<AsciiValue> AutoPtr;
//! @name Creators
//@{
//! Default constructor.
AsciiValue();
//! Constructor
explicit AsciiValue(const std::string& buf);
//! Virtual destructor.
virtual ~AsciiValue();
//@}
//! @name Manipulators
//@{
using StringValueBase::read;
/*!
@brief Set the value to that of the string buf. Overrides base class
to append a terminating '\\0' character if buf doesn't end
with '\\0'.
*/
virtual int read(const std::string& buf);
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
/*!
@brief Write the ASCII value up to the the first '\\0' character to an
output stream. Any further characters are ignored and not
written to the output stream.
*/
virtual std::ostream& write(std::ostream& os) const;
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual AsciiValue* clone_() const;
}; // class AsciiValue
/*!
@brief %Value for an Exif comment.
This can be a plain Ascii string or a multipe byte encoded string. The
comment is expected to be encoded in the character set indicated (default
undefined), but this is not checked. It is left to caller to decode and
encode the string to and from readable text if that is required.
*/
class EXIV2API CommentValue : public StringValueBase {
public:
//! Character set identifiers for the character sets defined by %Exif
enum CharsetId { ascii, jis, unicode, undefined,
invalidCharsetId, lastCharsetId };
//! Information pertaining to the defined character sets
struct CharsetTable {
//! Constructor
CharsetTable(CharsetId charsetId,
const char* name,
const char* code);
CharsetId charsetId_; //!< Charset id
const char* name_; //!< Name of the charset
const char* code_; //!< Code of the charset
}; // struct CharsetTable
//! Charset information lookup functions. Implemented as a static class.
class EXIV2API CharsetInfo {
//! Prevent construction: not implemented.
CharsetInfo() {}
//! Prevent copy-construction: not implemented.
CharsetInfo(const CharsetInfo&);
//! Prevent assignment: not implemented.
CharsetInfo& operator=(const CharsetInfo&);
public:
//! Return the name for a charset id
static const char* name(CharsetId charsetId);
//! Return the code for a charset id
static const char* code(CharsetId charsetId);
//! Return the charset id for a name
static CharsetId charsetIdByName(const std::string& name);
//! Return the charset id for a code
static CharsetId charsetIdByCode(const std::string& code);
private:
static const CharsetTable charsetTable_[];
}; // class CharsetInfo
//! Shortcut for a %CommentValue auto pointer.
typedef std::auto_ptr<CommentValue> AutoPtr;
//! @name Creators
//@{
//! Default constructor.
CommentValue();
//! Constructor, uses read(const std::string& comment)
explicit CommentValue(const std::string& comment);
//! Virtual destructor.
virtual ~CommentValue();
//@}
//! @name Manipulators
//@{
/*!
@brief Read the value from a comment
The format of \em comment is:
<BR>
<CODE>[charset=["]Ascii|Jis|Unicode|Undefined["] ]comment</CODE>
<BR>
The default charset is Undefined.
@return 0 if successful<BR>
1 if an invalid character set is encountered
*/
int read(const std::string& comment);
/*!
@brief Read the comment from a byte buffer.
*/
int read(const byte* buf, long len, ByteOrder byteOrder);
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
long copy(byte* buf, ByteOrder byteOrder) const;
/*!
@brief Write the comment in a format which can be read by
read(const std::string& comment).
*/
std::ostream& write(std::ostream& os) const;
/*!
@brief Return the comment (without a charset="..." prefix)
The comment is decoded to UTF-8. For Exif UNICODE comments, the
function makes an attempt to correctly determine the character
encoding of the value. Alternatively, the optional \em encoding
parameter can be used to specify it.
@param encoding Optional argument to specify the character encoding
that the comment is encoded in, as an iconv(3) name. Only used
for Exif UNICODE comments.
@return A string containing the comment converted to UTF-8.
*/
std::string comment(const char* encoding =0) const;
/*!
@brief Determine the character encoding that was used to encode the
UNICODE comment value as an iconv(3) name.
If the comment \em c starts with a BOM, the BOM is interpreted and
removed from the string.
Todo: Implement rules to guess if the comment is UTF-8 encoded.
*/
const char* detectCharset(std::string& c) const;
//! Return the Exif charset id of the comment
CharsetId charsetId() const;
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual CommentValue* clone_() const;
public:
// DATA
ByteOrder byteOrder_; //!< Byte order of the comment string that was read
}; // class CommentValue
/*!
@brief Base class for all Exiv2 values used to store XMP property values.
*/
class EXIV2API XmpValue : public Value {
public:
//! Shortcut for a %XmpValue auto pointer.
typedef std::auto_ptr<XmpValue> AutoPtr;
//! XMP array types.
enum XmpArrayType { xaNone, xaAlt, xaBag, xaSeq };
//! XMP structure indicator.
enum XmpStruct { xsNone, xsStruct };
//! @name Creators
//@{
explicit XmpValue(TypeId typeId);
//@}
//! @name Accessors
//@{
//! Return XMP array type, indicates if an XMP value is an array.
XmpArrayType xmpArrayType() const;
//! Return XMP struct, indicates if an XMP value is a structure.
XmpStruct xmpStruct() const;
virtual long size() const;
/*!
@brief Write value to a character data buffer.
The user must ensure that the buffer has enough memory. Otherwise
the call results in undefined behaviour.
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Data buffer to write to.
@param byteOrder Byte order. Not used.
@return Number of characters written.
*/
virtual long copy(byte* buf, ByteOrder byteOrder =invalidByteOrder) const;
//@}
//! @name Manipulators
//@{
//! Set the XMP array type to indicate that an XMP value is an array.
void setXmpArrayType(XmpArrayType xmpArrayType);
//! Set the XMP struct type to indicate that an XMP value is a structure.
void setXmpStruct(XmpStruct xmpStruct =xsStruct);
/*!
@brief Read the value from a character buffer.
Uses read(const std::string& buf)
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Pointer to the data buffer to read from
@param len Number of bytes in the data buffer
@param byteOrder Byte order. Not needed.
@return 0 if successful.
*/
virtual int read(const byte* buf,
long len,
ByteOrder byteOrder =invalidByteOrder);
virtual int read(const std::string& buf) =0;
//@}
/*!
@brief Return XMP array type for an array Value TypeId, xaNone if
\em typeId is not an XMP array value type.
*/
static XmpArrayType xmpArrayType(TypeId typeId);
protected:
/*!
@brief Assignment operator. Protected so that it can only be used
by subclasses but not directly.
*/
XmpValue& operator=(const XmpValue& rhs);
private:
// DATA
XmpArrayType xmpArrayType_; //!< Type of XMP array
XmpStruct xmpStruct_; //!< XMP structure indicator
}; // class XmpValue
/*!
@brief %Value type suitable for simple XMP properties and
XMP nodes of complex types which are not parsed into
specific values.
Uses a std::string to store the value.
*/
class EXIV2API XmpTextValue : public XmpValue {
public:
//! Shortcut for a %XmpTextValue auto pointer.
typedef std::auto_ptr<XmpTextValue> AutoPtr;
//! @name Creators
//@{
//! Constructor.
XmpTextValue();
//! Constructor, reads the value from a string.
explicit XmpTextValue(const std::string& buf);
//@}
//! @name Manipulators
//@{
using XmpValue::read;
/*!
@brief Read a simple property value from \em buf to set the value.
Sets the value to the contents of \em buf. A optional keyword,
\em type is supported to set the XMP value type. This is useful for
complex value types for which Exiv2 does not have direct support.
The format of \em buf is:
<BR>
<CODE>[type=["]Alt|Bag|Seq|Struct["] ]text</CODE>
<BR>
@return 0 if successful.
*/
virtual int read(const std::string& buf);
//@}
//! @name Accessors
//@{
AutoPtr clone() const;
long size() const;
virtual long count() const;
/*!
@brief Convert the value to a long.
The optional parameter \em n is not used and is ignored.
@return The converted value.
*/
virtual long toLong(long n =0) const;
/*!
@brief Convert the value to a float.
The optional parameter \em n is not used and is ignored.
@return The converted value.
*/
virtual float toFloat(long n =0) const;
/*!
@brief Convert the value to a Rational.
The optional parameter \em n is not used and is ignored.
@return The converted value.
*/
virtual Rational toRational(long n =0) const;
virtual std::ostream& write(std::ostream& os) const;
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual XmpTextValue* clone_() const;
public:
// DATA
std::string value_; //!< Stores the string values.
}; // class XmpTextValue
/*!
@brief %Value type for simple arrays. Each item in the array is a simple
value, without qualifiers. The array may be an ordered (\em seq),
unordered (\em bag) or alternative array (\em alt). The array
items must not contain qualifiers. For language alternatives use
LangAltValue.
Uses a vector of std::string to store the value(s).
*/
class EXIV2API XmpArrayValue : public XmpValue {
public:
//! Shortcut for a %XmpArrayValue auto pointer.
typedef std::auto_ptr<XmpArrayValue> AutoPtr;
//! @name Creators
//@{
//! Constructor. \em typeId can be one of xmpBag, xmpSeq or xmpAlt.
explicit XmpArrayValue(TypeId typeId =xmpBag);
//@}
//! @name Manipulators
//@{
using XmpValue::read;
/*!
@brief Read a simple property value from \em buf and append it
to the value.
Appends \em buf to the value after the last existing array element.
Subsequent calls will therefore populate multiple array elements in
the order they are read.
@return 0 if successful.
*/
virtual int read(const std::string& buf);
//@}
//! @name Accessors
//@{
AutoPtr clone() const;
virtual long count() const;
/*!
@brief Return the <EM>n</EM>-th component of the value as a string.
The behaviour of this method may be undefined if there is no
<EM>n</EM>-th component.
*/
virtual std::string toString(long n) const;
virtual long toLong(long n =0) const;
virtual float toFloat(long n =0) const;
virtual Rational toRational(long n =0) const;
/*!
@brief Write all elements of the value to \em os, separated by commas.
@note The output of this method cannot directly be used as the parameter
for read().
*/
virtual std::ostream& write(std::ostream& os) const;
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual XmpArrayValue* clone_() const;
public:
//! Type used to store XMP array elements.
typedef std::vector<std::string> ValueType;
// DATA
std::vector<std::string> value_; //!< Stores the string values.
}; // class XmpArrayValue
/*!
@brief %LangAltValueComparator
#1058
https://www.adobe.com/content/dam/Adobe/en/devnet/xmp/pdfs/XMPSpecificationPart1.pdf
XMP spec chapter B.4 (page 42) the xml:lang qualifier is to be compared case insensitive.
*/
struct LangAltValueComparator {
bool operator() (const std::string& str1, const std::string& str2) const
{
int result = str1.size() < str2.size() ? 1
: str1.size() > str2.size() ? -1
: 0
;
std::string::const_iterator c1 = str1.begin();
std::string::const_iterator c2 = str2.begin();
if ( result==0 ) for (
; result==0 && c1 != str1.end()
; ++c1, ++c2
) {
result = tolower(*c1) < tolower(*c2) ? 1
: tolower(*c1) > tolower(*c2) ? -1
: 0
;
}
return result < 0 ;
}
};
/*!
@brief %Value type for XMP language alternative properties.
A language alternative is an array consisting of simple text values,
each of which has a language qualifier.
*/
class EXIV2API LangAltValue : public XmpValue {
public:
//! Shortcut for a %LangAltValue auto pointer.
typedef std::auto_ptr<LangAltValue> AutoPtr;
//! @name Creators
//@{
//! Constructor.
LangAltValue();
//! Constructor, reads the value from a string.
explicit LangAltValue(const std::string& buf);
//@}
//! @name Manipulators
//@{
using XmpValue::read;
/*!
@brief Read a simple property value from \em buf and append it
to the value.
Appends \em buf to the value after the last existing array element.
Subsequent calls will therefore populate multiple array elements in
the order they are read.
The format of \em buf is:
<BR>
<CODE>[lang=["]language code["] ]text</CODE>
<BR>
The XMP default language code <CODE>x-default</CODE> is used if
\em buf doesn't start with the keyword <CODE>lang</CODE>.
@return 0 if successful.
*/
virtual int read(const std::string& buf);
//@}
//! @name Accessors
//@{
AutoPtr clone() const;
virtual long count() const;
/*!
@brief Return the text value associated with the default language
qualifier \c x-default. The parameter \em n is not used, but
it is suggested that only 0 is passed in. Returns an empty
string and sets the ok-flag to \c false if there is no
default value.
*/
virtual std::string toString(long n) const;
/*!
@brief Return the text value associated with the language qualifier
\em qualifier. Returns an empty string and sets the ok-flag
to \c false if there is no entry for the language qualifier.
*/
std::string toString(const std::string& qualifier) const;
virtual long toLong(long n =0) const;
virtual float toFloat(long n =0) const;
virtual Rational toRational(long n =0) const;
/*!
@brief Write all elements of the value to \em os, separated by commas.
@note The output of this method cannot directly be used as the parameter
for read().
*/
virtual std::ostream& write(std::ostream& os) const;
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual LangAltValue* clone_() const;
public:
//! Type used to store language alternative arrays.
typedef std::map<std::string, std::string,LangAltValueComparator> ValueType;
// DATA
/*!
@brief Map to store the language alternative values. The language
qualifier is used as the key for the map entries.
*/
ValueType value_;
}; // class LangAltValue
/*!
@brief %Value for simple ISO 8601 dates
This class is limited to parsing simple date strings in the ISO 8601
format CCYYMMDD (century, year, month, day).
*/
class EXIV2API DateValue : public Value {
public:
//! Shortcut for a %DateValue auto pointer.
typedef std::auto_ptr<DateValue> AutoPtr;
//! @name Creators
//@{
//! Default constructor.
DateValue();
//! Constructor
DateValue(int year, int month, int day);
//! Virtual destructor.
virtual ~DateValue();
//@}
//! Simple Date helper structure
struct EXIV2API Date {
Date() : year(0), month(0), day(0) {}
int year; //!< Year
int month; //!< Month
int day; //!< Day
};
//! @name Manipulators
//@{
/*!
@brief Read the value from a character buffer.
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Pointer to the data buffer to read from
@param len Number of bytes in the data buffer
@param byteOrder Byte order. Not needed.
@return 0 if successful<BR>
1 in case of an unsupported date format
*/
virtual int read(const byte* buf,
long len,
ByteOrder byteOrder =invalidByteOrder);
/*!
@brief Set the value to that of the string buf.
@param buf String containing the date
@return 0 if successful<BR>
1 in case of an unsupported date format
*/
virtual int read(const std::string& buf);
//! Set the date
void setDate(const Date& src);
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
/*!
@brief Write value to a character data buffer.
The user must ensure that the buffer has enough memory. Otherwise
the call results in undefined behaviour.
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Data buffer to write to.
@param byteOrder Byte order. Not used.
@return Number of characters written.
*/
virtual long copy(byte* buf, ByteOrder byteOrder =invalidByteOrder) const;
//! Return date struct containing date information
virtual const Date& getDate() const;
virtual long count() const;
virtual long size() const;
virtual std::ostream& write(std::ostream& os) const;
//! Return the value as a UNIX calender time converted to long.
virtual long toLong(long n =0) const;
//! Return the value as a UNIX calender time converted to float.
virtual float toFloat(long n =0) const;
//! Return the value as a UNIX calender time converted to Rational.
virtual Rational toRational(long n =0) const;
//@}
private:
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual DateValue* clone_() const;
// DATA
Date date_;
}; // class DateValue
/*!
@brief %Value for simple ISO 8601 times.
This class is limited to handling simple time strings in the ISO 8601
format HHMMSS�HHMM where HHMMSS refers to local hour, minute and
seconds and �HHMM refers to hours and minutes ahead or behind
Universal Coordinated Time.
*/
class EXIV2API TimeValue : public Value {
public:
//! Shortcut for a %TimeValue auto pointer.
typedef std::auto_ptr<TimeValue> AutoPtr;
//! @name Creators
//@{
//! Default constructor.
TimeValue();
//! Constructor
TimeValue(int hour, int minute, int second =0,
int tzHour =0, int tzMinute =0);
//! Virtual destructor.
virtual ~TimeValue();
//@}
//! Simple Time helper structure
struct Time
{
Time() : hour(0), minute(0), second(0), tzHour(0), tzMinute(0) {}
int hour; //!< Hour
int minute; //!< Minute
int second; //!< Second
int tzHour; //!< Hours ahead or behind UTC
int tzMinute; //!< Minutes ahead or behind UTC
};
//! @name Manipulators
//@{
/*!
@brief Read the value from a character buffer.
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Pointer to the data buffer to read from
@param len Number of bytes in the data buffer
@param byteOrder Byte order. Not needed.
@return 0 if successful<BR>
1 in case of an unsupported time format
*/
virtual int read(const byte* buf,
long len,
ByteOrder byteOrder =invalidByteOrder);
/*!
@brief Set the value to that of the string buf.
@param buf String containing the time.
@return 0 if successful<BR>
1 in case of an unsupported time format
*/
virtual int read(const std::string& buf);
//! Set the time
void setTime(const Time& src);
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
/*!
@brief Write value to a character data buffer.
The user must ensure that the buffer has enough memory. Otherwise
the call results in undefined behaviour.
@note The byte order is required by the interface but not used by this
method, so just use the default.
@param buf Data buffer to write to.
@param byteOrder Byte order. Not used.
@return Number of characters written.
*/
virtual long copy(byte* buf, ByteOrder byteOrder =invalidByteOrder) const;
//! Return time struct containing time information
virtual const Time& getTime() const;
virtual long count() const;
virtual long size() const;
virtual std::ostream& write(std::ostream& os) const;
//! Returns number of seconds in the day in UTC.
virtual long toLong(long n =0) const;
//! Returns number of seconds in the day in UTC converted to float.
virtual float toFloat(long n =0) const;
//! Returns number of seconds in the day in UTC converted to Rational.
virtual Rational toRational(long n =0) const;
//@}
private:
//! @name Manipulators
//@{
/*!
@brief Set time from \em buf if it conforms to \em format
(3 input items).
This function only sets the hour, minute and second parts of time_.
@param buf A 0 terminated C-string containing the time to parse.
@param format Format string for sscanf().
@return 0 if successful, else 1.
*/
EXV_DLLLOCAL int scanTime3(const char* buf, const char* format);
/*!
@brief Set time from \em buf if it conforms to \em format
(6 input items).
This function sets all parts of time_.
@param buf A 0 terminated C-string containing the time to parse.
@param format Format string for sscanf().
@return 0 if successful, else 1.
*/
EXV_DLLLOCAL int scanTime6(const char* buf, const char* format);
//@}
//! @name Accessors
//@{
//! Internal virtual copy constructor.
EXV_DLLLOCAL virtual TimeValue* clone_() const;
//@}
// DATA
Time time_;
}; // class TimeValue
//! Template to determine the TypeId for a type T
template<typename T> TypeId getType();
//! Specialization for an unsigned short
template<> inline TypeId getType<uint16_t>() { return unsignedShort; }
//! Specialization for an unsigned long
template<> inline TypeId getType<uint32_t>() { return unsignedLong; }
//! Specialization for an unsigned rational
template<> inline TypeId getType<URational>() { return unsignedRational; }
//! Specialization for a signed short
template<> inline TypeId getType<int16_t>() { return signedShort; }
//! Specialization for a signed long
template<> inline TypeId getType<int32_t>() { return signedLong; }
//! Specialization for a signed rational
template<> inline TypeId getType<Rational>() { return signedRational; }
//! Specialization for a float
template<> inline TypeId getType<float>() { return tiffFloat; }
//! Specialization for a double
template<> inline TypeId getType<double>() { return tiffDouble; }
// No default implementation: let the compiler/linker complain
// template<typename T> inline TypeId getType() { return invalid; }
/*!
@brief Template for a %Value of a basic type. This is used for unsigned
and signed short, long and rationals.
*/
template<typename T>
class ValueType : public Value {
public:
//! Shortcut for a %ValueType\<T\> auto pointer.
typedef std::auto_ptr<ValueType<T> > AutoPtr;
//! @name Creators
//@{
//! Default Constructor.
ValueType();
//! Constructor.
// The default c'tor and this one can be combined, but that causes MSVC 7.1 to fall on its nose
explicit ValueType(TypeId typeId);
//! Constructor.
ValueType(const byte* buf, long len, ByteOrder byteOrder, TypeId typeId =getType<T>());
//! Constructor.
explicit ValueType(const T& val, TypeId typeId =getType<T>());
//! Copy constructor
ValueType(const ValueType<T>& rhs);
//! Virtual destructor.
virtual ~ValueType();
//@}
//! @name Manipulators
//@{
//! Assignment operator.
ValueType<T>& operator=(const ValueType<T>& rhs);
virtual int read(const byte* buf, long len, ByteOrder byteOrder);
/*!
@brief Set the data from a string of values of type T (e.g.,
"0 1 2 3" or "1/2 1/3 1/4" depending on what T is).
Generally, the accepted input format is the same as that
produced by the write() method.
*/
virtual int read(const std::string& buf);
/*!
@brief Set the data area. This method copies (clones) the buffer
pointed to by buf.
*/
virtual int setDataArea(const byte* buf, long len);
//@}
//! @name Accessors
//@{
AutoPtr clone() const { return AutoPtr(clone_()); }
virtual long copy(byte* buf, ByteOrder byteOrder) const;
virtual long count() const;
virtual long size() const;
virtual std::ostream& write(std::ostream& os) const;
/*!
@brief Return the <EM>n</EM>-th component of the value as a string.
The behaviour of this method may be undefined if there is no
<EM>n</EM>-th
component.
*/
virtual std::string toString(long n) const;
virtual long toLong(long n =0) const;
virtual float toFloat(long n =0) const;
virtual Rational toRational(long n =0) const;
//! Return the size of the data area.
virtual long sizeDataArea() const;
/*!
@brief Return a copy of the data area in a DataBuf. The caller owns
this copy and DataBuf ensures that it will be deleted.
*/
virtual DataBuf dataArea() const;
//@}
//! Container for values
typedef std::vector<T> ValueList;
//! Iterator type defined for convenience.
typedef typename std::vector<T>::iterator iterator;
//! Const iterator type defined for convenience.
typedef typename std::vector<T>::const_iterator const_iterator;
// DATA
/*!
@brief The container for all values. In your application, if you know
what subclass of Value you're dealing with (and possibly the T)
then you can access this STL container through the usual
standard library functions.
*/
ValueList value_;
private:
//! Internal virtual copy constructor.
virtual ValueType<T>* clone_() const;
// DATA
//! Pointer to the buffer, 0 if none has been allocated
byte* pDataArea_;
//! The current size of the buffer
long sizeDataArea_;
}; // class ValueType
//! Unsigned short value type
typedef ValueType<uint16_t> UShortValue;
//! Unsigned long value type
typedef ValueType<uint32_t> ULongValue;
//! Unsigned rational value type
typedef ValueType<URational> URationalValue;
//! Signed short value type
typedef ValueType<int16_t> ShortValue;
//! Signed long value type
typedef ValueType<int32_t> LongValue;
//! Signed rational value type
typedef ValueType<Rational> RationalValue;
//! Float value type
typedef ValueType<float> FloatValue;
//! Double value type
typedef ValueType<double> DoubleValue;
// *****************************************************************************
// free functions, template and inline definitions
/*!
@brief Read a value of type T from the data buffer.
We need this template function for the ValueType template classes.
There are only specializations of this function available; no default
implementation is provided.
@param buf Pointer to the data buffer to read from.
@param byteOrder Applicable byte order (little or big endian).
@return A value of type T.
*/
template<typename T> T getValue(const byte* buf, ByteOrder byteOrder);
// Specialization for a 2 byte unsigned short value.
template<>
inline uint16_t getValue(const byte* buf, ByteOrder byteOrder)
{
return getUShort(buf, byteOrder);
}
// Specialization for a 4 byte unsigned long value.
template<>
inline uint32_t getValue(const byte* buf, ByteOrder byteOrder)
{
return getULong(buf, byteOrder);
}
// Specialization for an 8 byte unsigned rational value.
template<>
inline URational getValue(const byte* buf, ByteOrder byteOrder)
{
return getURational(buf, byteOrder);
}
// Specialization for a 2 byte signed short value.
template<>
inline int16_t getValue(const byte* buf, ByteOrder byteOrder)
{
return getShort(buf, byteOrder);
}
// Specialization for a 4 byte signed long value.
template<>
inline int32_t getValue(const byte* buf, ByteOrder byteOrder)
{
return getLong(buf, byteOrder);
}
// Specialization for an 8 byte signed rational value.
template<>
inline Rational getValue(const byte* buf, ByteOrder byteOrder)
{
return getRational(buf, byteOrder);
}
// Specialization for a 4 byte float value.
template<>
inline float getValue(const byte* buf, ByteOrder byteOrder)
{
return getFloat(buf, byteOrder);
}
// Specialization for a 8 byte double value.
template<>
inline double getValue(const byte* buf, ByteOrder byteOrder)
{
return getDouble(buf, byteOrder);
}
/*!
@brief Convert a value of type T to data, write the data to the data buffer.
We need this template function for the ValueType template classes.
There are only specializations of this function available; no default
implementation is provided.
@param buf Pointer to the data buffer to write to.
@param t Value to be converted.
@param byteOrder Applicable byte order (little or big endian).
@return The number of bytes written to the buffer.
*/
template<typename T> long toData(byte* buf, T t, ByteOrder byteOrder);
/*!
@brief Specialization to write an unsigned short to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, uint16_t t, ByteOrder byteOrder)
{
return us2Data(buf, t, byteOrder);
}
/*!
@brief Specialization to write an unsigned long to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, uint32_t t, ByteOrder byteOrder)
{
return ul2Data(buf, t, byteOrder);
}
/*!
@brief Specialization to write an unsigned rational to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, URational t, ByteOrder byteOrder)
{
return ur2Data(buf, t, byteOrder);
}
/*!
@brief Specialization to write a signed short to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, int16_t t, ByteOrder byteOrder)
{
return s2Data(buf, t, byteOrder);
}
/*!
@brief Specialization to write a signed long to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, int32_t t, ByteOrder byteOrder)
{
return l2Data(buf, t, byteOrder);
}
/*!
@brief Specialization to write a signed rational to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, Rational t, ByteOrder byteOrder)
{
return r2Data(buf, t, byteOrder);
}
/*!
@brief Specialization to write a float to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, float t, ByteOrder byteOrder)
{
return f2Data(buf, t, byteOrder);
}
/*!
@brief Specialization to write a double to the data buffer.
Return the number of bytes written.
*/
template<>
inline long toData(byte* buf, double t, ByteOrder byteOrder)
{
return d2Data(buf, t, byteOrder);
}
template<typename T>
ValueType<T>::ValueType()
: Value(getType<T>()), pDataArea_(0), sizeDataArea_(0)
{
}
template<typename T>
ValueType<T>::ValueType(TypeId typeId)
: Value(typeId), pDataArea_(0), sizeDataArea_(0)
{
}
template<typename T>
ValueType<T>::ValueType(const byte* buf, long len, ByteOrder byteOrder, TypeId typeId)
: Value(typeId), pDataArea_(0), sizeDataArea_(0)
{
read(buf, len, byteOrder);
}
template<typename T>
ValueType<T>::ValueType(const T& val, TypeId typeId)
: Value(typeId), pDataArea_(0), sizeDataArea_(0)
{
value_.push_back(val);
}
template<typename T>
ValueType<T>::ValueType(const ValueType<T>& rhs)
: Value(rhs), value_(rhs.value_), pDataArea_(0), sizeDataArea_(0)
{
if (rhs.sizeDataArea_ > 0) {
pDataArea_ = new byte[rhs.sizeDataArea_];
std::memcpy(pDataArea_, rhs.pDataArea_, rhs.sizeDataArea_);
sizeDataArea_ = rhs.sizeDataArea_;
}
}
template<typename T>
ValueType<T>::~ValueType()
{
delete[] pDataArea_;
}
template<typename T>
ValueType<T>& ValueType<T>::operator=(const ValueType<T>& rhs)
{
if (this == &rhs) return *this;
Value::operator=(rhs);
value_ = rhs.value_;
byte* tmp = 0;
if (rhs.sizeDataArea_ > 0) {
tmp = new byte[rhs.sizeDataArea_];
std::memcpy(tmp, rhs.pDataArea_, rhs.sizeDataArea_);
}
delete[] pDataArea_;
pDataArea_ = tmp;
sizeDataArea_ = rhs.sizeDataArea_;
return *this;
}
template<typename T>
int ValueType<T>::read(const byte* buf, long len, ByteOrder byteOrder)
{
value_.clear();
long ts = TypeInfo::typeSize(typeId());
if (ts != 0)
if (len % ts != 0) len = (len / ts) * ts;
for (long i = 0; i < len; i += ts) {
value_.push_back(getValue<T>(buf + i, byteOrder));
}
return 0;
}
template<typename T>
int ValueType<T>::read(const std::string& buf)
{
std::istringstream is(buf);
T tmp;
ValueList val;
while (!(is.eof())) {
is >> tmp;
if (is.fail()) return 1;
val.push_back(tmp);
}
value_.swap(val);
return 0;
}
template<typename T>
long ValueType<T>::copy(byte* buf, ByteOrder byteOrder) const
{
long offset = 0;
typename ValueList::const_iterator end = value_.end();
for (typename ValueList::const_iterator i = value_.begin(); i != end; ++i) {
offset += toData(buf + offset, *i, byteOrder);
}
return offset;
}
template<typename T>
long ValueType<T>::count() const
{
return static_cast<long>(value_.size());
}
template<typename T>
long ValueType<T>::size() const
{
return static_cast<long>(TypeInfo::typeSize(typeId()) * value_.size());
}
template<typename T>
ValueType<T>* ValueType<T>::clone_() const
{
return new ValueType<T>(*this);
}
template<typename T>
std::ostream& ValueType<T>::write(std::ostream& os) const
{
typename ValueList::const_iterator end = value_.end();
typename ValueList::const_iterator i = value_.begin();
while (i != end) {
os << std::setprecision(15) << *i;
if (++i != end) os << " ";
}
return os;
}
template<typename T>
std::string ValueType<T>::toString(long n) const
{
ok_ = true;
return Exiv2::toString<T>(value_[n]);
}
// Default implementation
template<typename T>
long ValueType<T>::toLong(long n) const
{
ok_ = true;
return static_cast<long>(value_[n]);
}
// Specialization for rational
template<>
inline long ValueType<Rational>::toLong(long n) const
{
ok_ = (value_[n].second != 0);
if (!ok_) return 0;
return value_[n].first / value_[n].second;
}
// Specialization for unsigned rational
template<>
inline long ValueType<URational>::toLong(long n) const
{
ok_ = (value_[n].second != 0);
if (!ok_) return 0;
return value_[n].first / value_[n].second;
}
// Default implementation
template<typename T>
float ValueType<T>::toFloat(long n) const
{
ok_ = true;
return static_cast<float>(value_[n]);
}
// Specialization for rational
template<>
inline float ValueType<Rational>::toFloat(long n) const
{
ok_ = (value_[n].second != 0);
if (!ok_) return 0.0f;
return static_cast<float>(value_[n].first) / value_[n].second;
}
// Specialization for unsigned rational
template<>
inline float ValueType<URational>::toFloat(long n) const
{
ok_ = (value_[n].second != 0);
if (!ok_) return 0.0f;
return static_cast<float>(value_[n].first) / value_[n].second;
}
// Default implementation
template<typename T>
Rational ValueType<T>::toRational(long n) const
{
ok_ = true;
return Rational(value_[n], 1);
}
// Specialization for rational
template<>
inline Rational ValueType<Rational>::toRational(long n) const
{
ok_ = true;
return Rational(value_[n].first, value_[n].second);
}
// Specialization for unsigned rational
template<>
inline Rational ValueType<URational>::toRational(long n) const
{
ok_ = true;
return Rational(value_[n].first, value_[n].second);
}
// Specialization for float.
template<>
inline Rational ValueType<float>::toRational(long n) const
{
ok_ = true;
// Warning: This is a very simple conversion, see floatToRationalCast()
return floatToRationalCast(value_[n]);
}
// Specialization for double.
template<>
inline Rational ValueType<double>::toRational(long n) const
{
ok_ = true;
// Warning: This is a very simple conversion, see floatToRationalCast()
return floatToRationalCast(static_cast<float>(value_[n]));
}
template<typename T>
long ValueType<T>::sizeDataArea() const
{
return sizeDataArea_;
}
template<typename T>
DataBuf ValueType<T>::dataArea() const
{
return DataBuf(pDataArea_, sizeDataArea_);
}
template<typename T>
int ValueType<T>::setDataArea(const byte* buf, long len)
{
byte* tmp = 0;
if (len > 0) {
tmp = new byte[len];
std::memcpy(tmp, buf, len);
}
delete[] pDataArea_;
pDataArea_ = tmp;
sizeDataArea_ = len;
return 0;
}
} // namespace Exiv2
#endif // #ifndef VALUE_HPP_
|