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
//! ``` //! use std::boxed::Box; //! use std::error::Error; //! use tidy::*; //! //! # pub fn main() -> Result<(), Box<dyn Error>> { //! let xml = "<test>5 < 6 and 9 > 7</test>"; //! let tidy = Tidy::new()?; //! tidy.opt_set_bool(TidyOptionId::TidyXmlTags, true)?; //! tidy.set_char_encoding("utf8")?; //! //! tidy.parse_string(xml.as_bytes().to_vec())?; //! //! tidy.clean_and_repair()?; //! match tidy.run_diagnostics() { //! Ok(v) => match v { //! TidySeverity::Error => { //! tidy.opt_set_bool(TidyOptionId::TidyForceOutput, true)?; //! } //! _ => (), //! }, //! Err(e) => return Err(Box::new(e)), //! } //! //! tidy.save_buffer()?; //! println!("\nDiagnostics:\n\n {}", TidyUtil::errbuf_as_string(&tidy)); //! print!("{}", String::from_utf8_lossy(&TidyUtil::output_as_vector(&tidy).unwrap())); //! # Ok(()) //! # } //! ``` #![allow(non_upper_case_globals)] #![allow(non_camel_case_types)] #![allow(non_snake_case)] extern crate tidy_sys; use libc::*; use std::boxed::Box; use std::error::Error; use std::ffi::CStr; use std::ffi::CString; use std::fmt; use tidy_sys::*; /// See [Html tidy docs](http://api.html-tidy.org/tidy/tidylib_api_5.6.0/group__public__enumerations.html) pub type TidyOptionId = tidy_sys::TidyOptionId; /// See [Html tidy docs](http://api.html-tidy.org/tidy/tidylib_api_5.6.0/group__public__enumerations.html) pub type TidyOption = tidy_sys::TidyOption; /// See [Html tidy docs](http://api.html-tidy.org/tidy/tidylib_api_5.6.0/group__public__enumerations.html) pub type TidyConfigCategory = tidy_sys::TidyConfigCategory; #[derive(Debug, Clone)] pub enum TidySeverity { Success, Warning, Error, Severe, } impl fmt::Display for TidySeverity { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { write!(f, "{:?}", self) } } #[derive(Debug, Clone)] pub struct TidyError { severity: TidySeverity, message: String, } impl std::fmt::Display for TidyError { fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { write!(f, "{}", self.message) } } impl Error for TidyError {} pub struct TidyUtil; impl TidyUtil { pub fn c_str_to_owned(in_str: ctmbstr) -> String { let c_str: &CStr = unsafe { CStr::from_ptr(in_str) }; let str_slice: &str = c_str.to_str().unwrap(); str_slice.to_owned() } pub fn bool_to_tidy_bool(bool_in: bool) -> Bool { match bool_in { true => Bool_yes, _ => Bool_no, } } pub fn tidy_bool_to_bool(tidy_bool_in: Bool) -> bool { match tidy_bool_in { Bool_yes => true, _ => false, } } pub fn output_as_vector(tidy: &Tidy) -> Option<Vec<u8>> { unsafe { if !(*tidy.output).bp.is_null() { let c_str: &CStr = CStr::from_ptr((*tidy.output).bp as *const i8); return Some(c_str.to_bytes().to_vec()); } } None } pub fn errbuf_as_string(tidy: &Tidy) -> String { unsafe { TidyUtil::c_str_to_owned((*tidy.errbuf).bp as *const i8) } } } pub struct Tidy { pub errbuf: *mut TidyBuffer, pub output: *mut TidyBuffer, tdoc: TidyDoc, } impl Tidy { pub fn new() -> Result<Tidy, TidyError> { let errbuf: TidyBuffer = Default::default(); let b_errbuf = Box::from(errbuf); let p_errbuf = Box::into_raw(b_errbuf); let output: TidyBuffer = Default::default(); let b_output = Box::from(output); let p_output = Box::into_raw(b_output); let tdoc = unsafe { tidyCreate() }; unsafe { match tidySetErrorBuffer(tdoc, p_errbuf) { 0 => Ok(Tidy { errbuf: p_errbuf, output: p_output, tdoc: tdoc, }), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy set errorbuffer error"), }), } } } // Basic operations /// Indicates the number of TidyAccess messages that were generated. /// /// # Returns /// Returns the number of TidyAccess messages that were generated. pub fn access_warning_count(&self) -> c_uint { unsafe { tidyAccessWarningCount(self.tdoc) } } /// Indicates the number of configuration error messages that were generated. /// /// # Returns /// Returns the number of configuration error messages that were generated. pub fn config_error_count(&self) -> c_uint { unsafe { tidyConfigErrorCount(self.tdoc) } } /// Indicates whether or not the input document was XML. /// /// If TidyXml tags is true, or there was an XML declaration in the input document, then this function will return yes. /// /// # Returns /// Returns true if the input document was XML. pub fn detected_generic_xml(&self) -> bool { unsafe { TidyUtil::tidy_bool_to_bool(tidyDetectedGenericXml(self.tdoc)) } } /// Gets the version of HTML that was output, as an integer, times 100. /// /// For example, HTML5 will return 500; HTML4.0.1 will return 401. /// /// # Returns /// Returns the HTML version number (x100). pub fn detected_html_version(&self) -> c_int { unsafe { tidyDetectedHtmlVersion(self.tdoc) } } /// Indicates whether the output document is or isn't XHTML. /// /// # Returns /// Returns true if the document is an XHTML type. pub fn detected_xhtml(&self) -> bool { unsafe { match tidyDetectedXhtml(self.tdoc) { Bool_yes => true, _ => false, } } } /// Indicates the number of TidyError messages that were generated. /// /// For any value greater than 0, output is suppressed unless TidyForceOutput is set. /// /// # Returns /// Returns the number of TidyError messages that were generated. pub fn error_count(&self) -> c_uint { unsafe { tidyErrorCount(self.tdoc) } } /// Get the version number for the current library. /// Returns /// The string representing the version number. pub fn library_version(&self) -> String { unsafe { TidyUtil::c_str_to_owned(tidyLibraryVersion()) } } /// Load an ASCII Tidy configuration file and set the configuration per its contents. /// /// # Returns /// Returns TidySeverity::Success upon success, or a TidyError if there was an error. /// /// # Parameters /// **config_file** The complete path to the file to load. pub fn load_config(&self, config_file: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidyLoadConfig(self.tdoc, CString::new(config_file).unwrap().as_ptr()) { 0 => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy load config error"), }), } } } /// Get the release date for the current library. /// /// # Returns /// The string representing the release date. pub fn release_date(&self) -> String { unsafe { TidyUtil::c_str_to_owned(tidyReleaseDate()) } } /// Set the input/output character encoding for parsing markup. /// /// Valid values include ascii, latin1, raw, utf8, iso2022, mac, win1252, utf16le, utf16be, utf16, big5, and shiftjis. These values are not case sensitive. /// /// # Note /// This is the same as using set_in_char_encoding() and set_out_char_encoding() to set the same value. /// # Parameters /// **encnam** The encoding name as described above. /// # Returns /// Returns TidySeverity::Success upon success, or a TidyError if there was an error. pub fn set_char_encoding(&self, encnam: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidySetCharEncoding(self.tdoc, CString::new(encnam).unwrap().as_ptr()) { 0 => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy set char encoding error"), }), } } } /// Set the input encoding for parsing markup. /// /// Valid values include ascii, latin1, raw, utf8, iso2022, mac, win1252, utf16le, utf16be, utf16, big5, and shiftjis. These values are not case sensitive. /// /// # Parameters /// **encnam** The encoding name as described above. /// # Returns /// Returns TidySeverity::Success upon success, or a TidyError if there was an error. pub fn set_in_char_encoding(&self, encnam: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidySetInCharEncoding(self.tdoc, CString::new(encnam).unwrap().as_ptr()) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy set in char encoding error"), }), } } } /// Set the output encoding for writing markup. /// /// Valid values include ascii, latin1, raw, utf8, iso2022, mac, win1252, utf16le, utf16be, utf16, big5, and shiftjis. These values are not case sensitive. /// /// # Parameters /// **encnam** The encoding name as described above. /// # Returns /// Returns TidySeverity::Success upon success, or a TidyError if there was an error. pub fn set_out_char_encoding(&self, encnam: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidySetOutCharEncoding(self.tdoc, CString::new(encnam).unwrap().as_ptr()) { 0 => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy set out char encoding error"), }), } } } /// Get status of current document. /// /// # Returns /// Returns TidySeverity::Error indicating that errors were present in the document, TidySeverity::Warning indicating warnings, and TidySeverity::Success in the case of everything being okay. pub fn status(&self) -> TidySeverity { unsafe { match tidyStatus(self.tdoc) { 0 => TidySeverity::Success, 1 => TidySeverity::Warning, 2 => TidySeverity::Error, _ => TidySeverity::Severe, } } } /// Indicates the number of TidyWarning messages that were generated. /// /// # Returns /// Returns the number of warning messages that were generated. pub fn warning_count(&self) -> c_uint { unsafe { tidyWarningCount(self.tdoc) } } // Configuration options /// Retrieves an instance of TidyOption given a valid TidyOptionId. /// /// # Parameters /// **optid** The TidyOptionId to retrieve. /// # Returns /// An instance of TidyOption matching the provided TidyOptionId. pub fn get_option(&self, optid: TidyOptionId) -> TidyOption { unsafe { tidyGetOption(self.tdoc, optid) } } /// Returns an instance of TidyOption by providing the name of a Tidy configuration option. /// /// # Parameters /// **optnam** The name of the Tidy configuration option. /// # Returns /// The TidyOption of the given optname. pub fn get_option_by_name(&self, optnam: &str) -> TidyOption { unsafe { tidyGetOptionByName(self.tdoc, CString::new(optnam).unwrap().as_ptr()) } } /// Copy current configuration settings from one document to another. /// /// Note that the destination document's existing settings will be stored as that document's snapshot prior to having its option values overwritten by the source document's settings. /// /// # Parameters /// **tdoc_to** The destination tidy document. /// # Returns /// Returns TidySeverity::Success indicating success or a TidyError on failure. pub fn opt_copy_config(&self, tdoc_to: TidyDoc) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptCopyConfig(tdoc_to, self.tdoc) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy reset to default error"), }), } } } /// Checks if settings are different than default /// /// Returns /// # Returns a bool indicating whether or not a difference exists. pub fn opt_diff_than_default(&self) -> bool { unsafe { match tidyOptDiffThanDefault(self.tdoc) { Bool_yes => true, _ => false, } } } /// Checks if settings are different than snapshot /// /// Returns /// # Returns a bool indicating whether or not a difference exists. pub fn opt_diff_than_snapshot(&self) -> bool { unsafe { match tidyOptDiffThanSnapshot(self.tdoc) { Bool_yes => true, _ => false, } } } /// Get current option value as a Boolean flag. /// /// # Parameters /// **optid** The option ID to get. /// # Returns /// Returns a bool indicating the value. pub fn tidyOptGetBool(&self, optid: TidyOptionId) -> bool { unsafe { match tidyOptGetBool(self.tdoc, optid) { Bool_yes => true, _ => false, } } } /// Get category of given Option. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// The TidyConfigCategory of the specified option. pub fn opt_get_category(opt: TidyOption) -> TidyConfigCategory { unsafe { tidyOptGetCategory(opt) } } /// Get default value of given Option as a string. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// A string indicating the default value of the specified option. pub fn opt_get_default(opt: TidyOption) -> String { unsafe { TidyUtil::c_str_to_owned(tidyOptGetDefault(opt)) } } /// Get default value of given Option as a Boolean value. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// A boolean indicating the default value of the specified option. pub fn opt_get_default_bool(opt: TidyOption) -> bool { unsafe { match tidyOptGetDefaultBool(opt) { Bool_yes => true, _ => false, } } } /// Get default value of given Option as an unsigned integer. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// An unsigned integer indicating the default value of the specified option. pub fn opt_get_default_int(opt: TidyOption) -> c_ulong { unsafe { tidyOptGetDefaultInt(opt) } } /// Get the description of the specified option. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// Returns a string containing a description of the given option. pub fn opt_get_doc(&self, opt: TidyOption) -> String { unsafe { TidyUtil::c_str_to_owned(tidyOptGetDoc(self.tdoc, opt)) } } /// Get character encoding name. /// /// Used with TidyCharEncoding, TidyOutCharEncoding, and TidyInCharEncoding. /// # Parameters /// **optid** The option ID whose value to check. /// # Returns /// The encoding name as a string for the specified option. pub fn opt_get_enc_name(&self, optid: TidyOptionId) -> String { unsafe { TidyUtil::c_str_to_owned(tidyOptGetEncName(self.tdoc, optid)) } } /// Get ID of given Option. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// The TidyOptionId of the given option. pub fn opt_get_name(opt: TidyOption) -> String { unsafe { TidyUtil::c_str_to_owned(tidyOptGetName(opt)) } } /// Get ID of given Option. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// The TidyOptionId of the given option. pub fn opt_get_id(opt: TidyOption) -> TidyOptionId { unsafe { tidyOptGetId(opt) } } /// Returns the TidyOptionId (enum value) by providing the name of a Tidy configuration option. /// /// # Parameters /// **optnam** The name of the option ID to retrieve. /// # Returns /// The TidyOptionId of the given optname. pub fn opt_get_id_for_name(optnam: &str) -> TidyOptionId { unsafe { tidyOptGetIdForName(CString::new(optnam).unwrap().as_ptr()) } } /// Get current option value as an integer. /// /// # Parameters /// optid The option ID to get. /// # Returns /// Returns the integer value of the specified option. pub fn opt_get_int(&self, optid: TidyOptionId) -> c_ulong { unsafe { tidyOptGetInt(self.tdoc, optid) } } /// Get datatype of given Option. /// /// # Parameters /// **opt** An instance of a TidyOption to query. /// # Returns /// The TidyOptionType of the given option. pub fn opt_get_type(opt: TidyOption) -> TidyOptionType { unsafe { tidyOptGetType(opt) } } /// Get the current value of the option ID for the given document. /// /// # Remarks /// The **optid** must have a TidyOptionType of TidyString! /// # Parameters /// **optid** The option ID whose value you wish to check. pub fn opt_get_value(&self, optid: TidyOptionId) -> String { unsafe { TidyUtil::c_str_to_owned(tidyOptGetValue(self.tdoc, optid)) } } /// Set named option value as a string, regardless of the TidyOptionType. /// /// # Remarks /// This is good setter if you are unsure of the type. /// # Parameters /// **optnam** The name of the option to set; this is the string value from the UI, e.g., error-file. /// # Returns /// Returns TidySeverity::Success indicating success or a TidyError on failure. /// **val** The value to set. pub fn opt_parse_value(&self, optnam: &str, val: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptParseValue( self.tdoc, CString::new(optnam).unwrap().as_ptr(), CString::new(val).unwrap().as_ptr(), ) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy option parse value error"), }), } } } /// Reset all options to their default values. /// /// # Returns /// Returns TidySeverity::Success indicating success or TidyError on failure. pub fn opt_reset_all_to_default(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptResetAllToDefault(self.tdoc) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy reset to default error"), }), } } } /// Reset option to default value by ID. /// /// Parameters /// **opt** The option ID to reset /// # Returns /// Returns a TidySeverity::Success indicating success or TidyError on failure. pub fn opt_reset_to_default(&self, optid: TidyOptionId) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptResetToDefault(self.tdoc, optid) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy reset to default error"), }), } } } /// Apply a snapshot of config settings to a document. /// /// # Returns /// Returns a TidySeverity::Success indicating success or TidyError on failure. pub fn opt_reset_to_snapshot(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptResetToSnapshot(self.tdoc) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy reset to snapshot error"), }), } } } /// Set option value as a Boolean flag. /// /// # Parameters /// **optid** The option ID to set. /// **val** The value to set. /// # Returns /// Returns a TidySeverity::Success indicating success or TidyError on failure. pub fn opt_set_bool(&self, optid: TidyOptionId, val: bool) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptSetBool(self.tdoc, optid, TidyUtil::bool_to_tidy_bool(val)) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy option set bool error"), }), } } } /// Set option value as an integer. /// /// # Parameters /// **optId** The option ID to set. /// **val** The value to set. /// # Returns /// Returns a TidySeverity::Success indicating success or TidyError on failure. pub fn opt_set_int(&self, optid: TidyOptionId, val: c_ulong) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptSetInt(self.tdoc, optid, val) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy option set int error"), }), } } } /// Set the option value as a string. /// /// # Parameters /// **optId** The option ID of the value to set. /// **val** The string value to set. /// # Returns /// Returns a TidySeverity::Success indicating success or TidyError on failure. pub fn opt_set_value(&self, optid: TidyOptionId, val: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptSetValue(self.tdoc, optid, CString::new(val).unwrap().as_ptr()) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy option set value error"), }), } } } /// Take a snapshot of current config settings. /// /// These settings are stored within the tidy document. Note, however, that snapshots do not reliably survive the tidyParseXXX() process, as Tidy uses the snapshot mechanism in order to store the current configuration right at the beginning of the parsing process. /// /// # Returns /// Returns a TidySeverity::Success indicating success or TidyError on failure. pub fn opt_snapshot(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptSnapshot(self.tdoc) { Bool_yes => Ok(TidySeverity::Success), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy option snapshot error"), }), } } } // Diagnose and repair /// Execute configured cleanup and repair operations on parsed markup. /// /// # Returns /// An integer representing the status. pub fn clean_and_repair(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidyCleanAndRepair(self.tdoc) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy clean and repair error"), }), } } } /// Reports the document type into the output sink. /// /// # Returns /// An integer representing the status. pub fn report_doctype(&self) -> TidySeverity { unsafe { match tidyReportDoctype(self.tdoc) { 0 => TidySeverity::Success, 1 => TidySeverity::Warning, 2 => TidySeverity::Error, _ => TidySeverity::Severe, } } } /// Reports the document type and diagnostic statistics on parsed and repaired markup. /// /// You must call tidyCleanAndRepair() before using this function. /// /// # Returns /// An integer representing the status. pub fn run_diagnostics(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidyRunDiagnostics(self.tdoc) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy run diagnostics error"), }), } } } // Document Parse /// Parse markup in named file. /// /// # Returns /// Returns tTidySeverity::Error indicating that errors were present in the document, TidySeverity::Warning indicating warnings, and TidySeverity::Success in the case of everything being okay. /// # Parameters /// **filename** The filename to parse. pub fn parse_file(&self, filename: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidyParseFile(self.tdoc, CString::new(filename).unwrap().as_ptr()) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy parse file error"), }), } } } /// Parse markup from the standard input. /// /// Returns /// Returns tTidySeverity::Error indicating that errors were present in the document, TidySeverity::Warning indicating warnings, and TidySeverity::Success in the case of everything being okay. pub fn parse_stdin(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidyParseStdin(self.tdoc) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy parse stdin error"), }), } } } /// Parse markup in given string. /// /// Returns /// Returns tTidySeverity::Error indicating that errors were present in the document, TidySeverity::Warning indicating warnings, and TidySeverity::Success in the case of everything being okay. /// # Parameters /// **content** The string to parse. pub fn parse_string(&self, content: Vec<u8>) -> Result<TidySeverity, TidyError> { unsafe { let c_input = CString::from_vec_unchecked(content); let raw_input = c_input.into_raw(); let rc = tidyParseString(self.tdoc, raw_input); let _c_input = CString::from_raw(raw_input); match rc { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy parse string error"), }), } } } // Document save functions /// Save current settings to named file. /// /// Only writes non-default values. /// /// # Returns /// A TidySeverity or a TidyError representing the status. /// # Parameters /// **cfgfil** The filename to save the configuration to. pub fn opt_save_file(&self, cfgfil: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidyOptSaveFile(self.tdoc, CString::new(cfgfil).unwrap().as_ptr()) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy save option file error"), }), } } } /// Save the tidy document to given TidyBuffer object. /// /// # Returns /// A TidySeverity or a TidyError representing the status. pub fn save_buffer(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidySaveBuffer(self.tdoc, self.output) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy save buffer error"), }), } } } /// Save the tidy document to the named file. /// /// # Returns /// A TidySeverity or a TidyError representing the status. /// # Parameters /// **filename** The destination file name. pub fn save_file(&self, filename: &str) -> Result<TidySeverity, TidyError> { unsafe { match tidySaveFile(self.tdoc, CString::new(filename).unwrap().as_ptr()) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy save file error"), }), } } } /// Save the tidy document to standard output (FILE*). /// /// # Returns /// A TidySeverity or a TidyError representing the status. pub fn save_stdout(&self) -> Result<TidySeverity, TidyError> { unsafe { match tidySaveStdout(self.tdoc) { 0 => Ok(TidySeverity::Success), 1 => Ok(TidySeverity::Warning), 2 => Ok(TidySeverity::Error), _ => Err(TidyError { severity: TidySeverity::Severe, message: String::from("Tidy save stdout error"), }), } } } } impl Drop for Tidy { fn drop(&mut self) { unsafe { //println! {"{:?}", *self.errbuf} if !(*self.errbuf).bp.is_null() { tidyBufFree(self.errbuf); } Box::from_raw(self.errbuf); //println! {"{:?}", *self.errbuf} if !(*self.output).bp.is_null() { tidyBufFree(self.output); } Box::from_raw(self.output); //println! {"{:?}", *self.output} tidyRelease(self.tdoc); } } }