Class TidyFFI::Interface
In: lib/tidy_ffi/interface.rb
Parent: Object

Low level interface to libtidy.

Methods

apply_options   clean   clean_and_repair   default_options   errors   option_valid?   output   repair   string=   with_buffer_pointer   with_doc   with_redirected_error_buffer  

Constants

LibTidy = TidyFFI::LibTidy

Public Class methods

default_options()

Returns a hash that represents default options for tidy. Key for hash is the option name, value is also a hash… Possible values are:

  • :type - either :string, :integer, :boolean or :enum
  • :readonly?
  • :default - default value of an option
  • :values - possible values for :enum
  • :name
option_valid?(option, value)

Returns true if value is valid for option and false otherwise.

with_doc() {|nd| ...}

Returns a TidyFFI::Interface with initialized interface.

Public Instance methods

clean()

Cleans string

clean_and_repair()

Alias for clean

output()

Returns output from tidy library

repair()

Alias for clean

string=(str)

Sets string to tidy

with_buffer_pointer() {|buf| ...}

Yields block with new buffer

[Validate]