/usr/include/yuma/ncx/ncx_num.h is in libyuma-dev 2.10-1build1.
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 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_ncx_num
#define _H_ncx_num
/* FILE: ncx_num.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
NCX Module Library Number Utility Functions
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
17-feb-10 abb Begun; split out from ncx.c
*/
#include <xmlstring.h>
#ifndef _H_dlq
#include "dlq.h"
#endif
#ifndef _H_ncxtypes
#include "ncxtypes.h"
#endif
#ifndef _H_tk
#include "tk.h"
#endif
#ifndef _H_typ
#include "typ.h"
#endif
#ifndef _H_val
#include "val.h"
#endif
#ifndef _H_xmlns
#include "xmlns.h"
#endif
#ifndef _H_yang
#include "yang.h"
#endif
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION ncx_init_num
*
* Init a ncx_num_t struct
*
* INPUTS:
* num == number to initialize
*********************************************************************/
extern void
ncx_init_num (ncx_num_t *num);
/********************************************************************
* FUNCTION ncx_clean_num
*
* Scrub the memory in a ncx_num_t by freeing all
* the sub-fields. DOES NOT free the entire struct itself
* The struct must be removed from any queue it is in before
* this function is called.
*
* INPUTS:
* btyp == base type of number
* num == ncx_num_t data structure to clean
*********************************************************************/
extern void
ncx_clean_num (ncx_btype_t btyp,
ncx_num_t *num);
/********************************************************************
* FUNCTION ncx_compare_nums
*
* Compare 2 ncx_num_t union contents
*
* INPUTS:
* num1 == first number
* num2 == second number
* btyp == expected data type (NCX_BT_INT, UINT, REAL)
* RETURNS:
* -1 if num1 is < num2
* 0 if num1 == num2
* 1 if num1 is > num2
*********************************************************************/
extern int32
ncx_compare_nums (const ncx_num_t *num1,
const ncx_num_t *num2,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_set_num_min
*
* Set a number to the minimum value for its type
*
* INPUTS:
* num == number to set
* btyp == expected data type
*
*********************************************************************/
extern void
ncx_set_num_min (ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_set_num_max
*
* Set a number to the maximum value for its type
*
* INPUTS:
* num == number to set
* btyp == expected data type
*
*********************************************************************/
extern void
ncx_set_num_max (ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_set_num_one
*
* Set a number to one
*
* INPUTS:
* num == number to set
* btyp == expected data type
*
*********************************************************************/
extern void
ncx_set_num_one (ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_set_num_zero
*
* Set a number to zero
*
* INPUTS:
* num == number to set
* btyp == expected data type
*
*********************************************************************/
extern void
ncx_set_num_zero (ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_set_num_nan
*
* Set a FP number to the Not a Number value
*
* INPUTS:
* num == number to set
* btyp == expected data type
*
*********************************************************************/
extern void
ncx_set_num_nan (ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_num_is_nan
*
* Check if a FP number is set to the Not a Number value
*
* INPUTS:
* num == number to check
* btyp == expected data type
*
* RETURNS:
* TRUE if number is not-a-number (NaN)
* FALSE otherwise
*********************************************************************/
extern boolean
ncx_num_is_nan (ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_num_zero
*
* Compare a ncx_num_t to zero
*
* INPUTS:
* num == number to check
* btyp == expected data type (e.g., NCX_BT_INT32, NCX_BT_UINT64)
*
* RETURNS:
* TRUE if value is equal to zero
* FALSE if value is not equal to zero
*********************************************************************/
extern boolean
ncx_num_zero (const ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_convert_num
*
* Convert a number string to a numeric type
*
* INPUTS:
* numstr == number string
* numfmt == NCX_NF_OCTAL, NCX_NF_DEC, NCX_NF_HEX, or NCX_NF_REAL
* btyp == desired number type
* (e.g., NCX_BT_INT32, NCX_BT_UINT32, NCX_BT_FLOAT64)
* val == pointer to ncx_num_t to hold result
*
* OUTPUTS:
* *val == converted number value
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_convert_num (const xmlChar *numstr,
ncx_numfmt_t numfmt,
ncx_btype_t btyp,
ncx_num_t *val);
/********************************************************************
* FUNCTION ncx_convert_dec64
*
* Convert a number string to a decimal64 number
*
* INPUTS:
* numstr == number string
* numfmt == number format used
* digits == number of fixed-point digits expected
* val == pointer to ncx_num_t to hold result
*
* OUTPUTS:
* *val == converted number value
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_convert_dec64 (const xmlChar *numstr,
ncx_numfmt_t numfmt,
uint8 digits,
ncx_num_t *val);
/********************************************************************
* FUNCTION ncx_decode_num
*
* Handle some sort of number string
*
* INPUTS:
* numstr == number string
* btyp == desired number type
* retnum == pointer to initialized ncx_num_t to hold result
*
* OUTPUTS:
* *retnum == converted number
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_decode_num (const xmlChar *numstr,
ncx_btype_t btyp,
ncx_num_t *retnum);
/********************************************************************
* FUNCTION ncx_decode_dec64
*
* Handle some sort of decimal64 number string (NCX_BT_DECIMAL64)
*
* INPUTS:
* numstr == number string
* digits == number of expected digits for this decimal64
* retnum == pointer to initialized ncx_num_t to hold result
*
* OUTPUTS:
* *retnum == converted number
*
* RETURNS:
* status of the operation
*********************************************************************/
extern status_t
ncx_decode_dec64 (const xmlChar *numstr,
uint8 digits,
ncx_num_t *retnum);
/********************************************************************
* FUNCTION ncx_copy_num
*
* Copy the contents of num1 to num2
*
* Supports all NCX numeric types:
* NCX_BT_INT*
* NCX_BT_UINT*
* NCX_BT_DECIMAL64
* NCX_BT_FLOAT64
*
* INPUTS:
* num1 == first number
* num2 == second number
* btyp == expected data type (NCX_BT_INT, UINT, REAL)
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_copy_num (const ncx_num_t *num1,
ncx_num_t *num2,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_cast_num
*
* Cast a number as another number type
*
* Supports all NCX numeric types:
* NCX_BT_INT*
* NCX_BT_UINT*
* NCX_BT_FLOAT64
*
* INPUTS:
* num1 == source number
* btyp1 == expected data type of num1
* num2 == target number
* btyp2 == desired data type of num2
*
* OUTPUTS:
* *num2 set to cast value of num1
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_cast_num (const ncx_num_t *num1,
ncx_btype_t btyp1,
ncx_num_t *num2,
ncx_btype_t btyp2);
/********************************************************************
* FUNCTION ncx_num_floor
*
* Get the floor value of a number
*
* Supports all NCX numeric types:
* NCX_BT_INT*
* NCX_BT_UINT*
* NCX_BT_DECIMAL64
* NCX_BT_FLOAT64
*
* INPUTS:
* num1 == source number
* num2 == address of target number
* btyp == expected data type of numbers
*
* OUTPUTS:
* *num2 set to floor of num1
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_num_floor (const ncx_num_t *num1,
ncx_num_t *num2,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_num_ceiling
*
* Get the ceiling value of a number
*
* Supports all NCX numeric types:
* NCX_BT_INT*
* NCX_BT_UINT*
* NCX_BT_DECIMAL64
* NCX_BT_FLOAT64
*
* INPUTS:
* num1 == source number
* num2 == target number
* btyp == expected data type of numbers
*
* OUTPUTS:
* *num2 set to ceiling of num1
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_num_ceiling (const ncx_num_t *num1,
ncx_num_t *num2,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_round_num
*
* Get the rounded value of a number
*
* Supports all NCX numeric types:
* NCX_BT_INT*
* NCX_BT_UINT*
* NCX_BT_DECIMAL64
* NCX_BT_FLOAT64
*
* INPUTS:
* num1 == source number
* num2 == target number
* btyp == expected data type of numbers
*
* OUTPUTS:
* *num2 set to round of num1
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_round_num (const ncx_num_t *num1,
ncx_num_t *num2,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_num_is_integral
*
* Check if the number is integral or if it has a fractional part
* Supports all NCX numeric types:
* NCX_BT_INT*
* NCX_BT_UINT*
* NCX_BT_DECIMAL64
* NCX_BT_FLOAT64
*
* INPUTS:
* num == number to check
* btyp == expected data type
*
* RETURNS:
* TRUE if integral, FALSE if not
*********************************************************************/
extern boolean
ncx_num_is_integral (const ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_cvt_to_int64
*
* Convert a number to an integer64;
* Use rounding for float64
*
* INPUTS:
* num == number to convert
* btyp == data type of num
*
* RETURNS:
* int64 representation
*********************************************************************/
extern int64
ncx_cvt_to_int64 (const ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_get_numfmt
*
* Get the number format of the specified string
* Does not check for valid format
* Just figures out which type it must be if it were valid
*
* INPUTS:
* numstr == number string
*
* RETURNS:
* NCX_NF_NONE, NCX_NF_DEC, NCX_NF_HEX, or NCX_NF_REAL
*********************************************************************/
extern ncx_numfmt_t
ncx_get_numfmt (const xmlChar *numstr);
/********************************************************************
* FUNCTION ncx_printf_num
*
* Printf a ncx_num_t contents
*
* INPUTS:
* num == number to printf
* btyp == number base type
*
*********************************************************************/
extern void
ncx_printf_num (const ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_alt_printf_num
*
* Printf a ncx_num_t contents to the alternate log file
*
* INPUTS:
* num == number to printf
* btyp == number base type
*
*********************************************************************/
extern void
ncx_alt_printf_num (const ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_sprintf_num
*
* Sprintf a ncx_num_t contents
*
* INPUTS:
* buff == buffer to write; NULL means just get length
* num == number to printf
* btyp == number base type
* len == address of return length
*
* OUTPUTS::
* *len == number of bytes written (or would have been) to buff
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_sprintf_num (xmlChar *buff,
const ncx_num_t *num,
ncx_btype_t btyp,
uint32 *len);
/********************************************************************
* FUNCTION ncx_is_min
*
* Return TRUE if the specified number is the min value
* for its type
*
* INPUTS:
* num == number to check
* btyp == data type of num
* RETURNS:
* TRUE if this is the minimum value
* FALSE otherwise
*********************************************************************/
extern boolean
ncx_is_min (const ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_is_max
*
* Return TRUE if the specified number is the max value
* for its type
*
* INPUTS:
* num == number to check
* btyp == data type of num
* RETURNS:
* TRUE if this is the maximum value
* FALSE otherwise
*********************************************************************/
extern boolean
ncx_is_max (const ncx_num_t *num,
ncx_btype_t btyp);
/********************************************************************
* FUNCTION ncx_convert_tkcnum
*
* Convert the current token in a token chain to
* a ncx_num_t struct
*
* INPUTS:
* tkc == token chain; current token will be converted
* tkc->typ == TK_TT_DNUM, TK_TT_HNUM, TK_TT_RNUM
* btyp == desired number type
* (e.g., NCX_BT_INT32, NCX_BT_UINT64, NCX_BT_FLOAT64)
* OUTPUTS:
* *val == converted number value (0..2G-1), if NO_ERR
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_convert_tkcnum (tk_chain_t *tkc,
ncx_btype_t btyp,
ncx_num_t *val);
/********************************************************************
* FUNCTION ncx_convert_tkc_dec64
*
* Convert the current token in a token chain to
* a ncx_num_t struct, expecting NCX_BT_DECIMAL64
*
* INPUTS:
* tkc == token chain; current token will be converted
* tkc->typ == TK_TT_DNUM, TK_TT_HNUM, TK_TT_RNUM
* digits == number of expected digits
*
* OUTPUTS:
* *val == converted number value, if NO_ERR
*
* RETURNS:
* status
*********************************************************************/
extern status_t
ncx_convert_tkc_dec64 (tk_chain_t *tkc,
uint8 digits,
ncx_num_t *val);
/********************************************************************
* FUNCTION ncx_get_dec64_base
*
* Get the base part of a decimal64 number
*
* INPUT:
* num == number to check (expected to be NCX_BT_DECIMAL64)
*
* RETURNS:
* base part of the number
*********************************************************************/
extern int64
ncx_get_dec64_base (const ncx_num_t *num);
/********************************************************************
* FUNCTION ncx_get_dec64_fraction
*
* Get the fraction part of a decimal64 number
*
* INPUT:
* num == number to check (expected to be NCX_BT_DECIMAL64)
*
* RETURNS:
* fraction part of the number
*********************************************************************/
extern int64
ncx_get_dec64_fraction (const ncx_num_t *num);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_ncx_num */
|