?HAMA

Navigation

Breadcrumbs

/ / proc / thread-self / root / opt / alt / ruby33 / share / gems / gems / rdoc-6.6.3.1 / lib / rdoc

Create

Create File | Create Folder | Upload Files | Run Command

Edit File Size: 3.37 KB

/proc/thread-self/root/opt/alt/ruby33/share/gems/gems/rdoc-6.6.3.1/lib/rdoc/encoding.rb

Text Base64

# coding: US-ASCII
# frozen_string_literal: true

##
# This class is a wrapper around File IO and Encoding that helps RDoc load
# files and convert them to the correct encoding.

module RDoc::Encoding

HEADER_REGEXP = /^
    (?:
      \A\#!.*\n
      |
      ^\#\s+frozen[-_]string[-_]literal[=:].+\n
      |
      ^\#[^\n]+\b(?:en)?coding[=:]\s*(?<name>[^\s;]+).*\n
      |
      <\?xml[^?]*encoding=(?<quote>["'])(?<name>.*?)\k<quote>.*\n
    )+
  /xi # :nodoc:

##
  # Reads the contents of +filename+ and handles any encoding directives in
  # the file.
  #
  # The content will be converted to the +encoding+.  If the file cannot be
  # converted a warning will be printed and nil will be returned.
  #
  # If +force_transcode+ is true the document will be transcoded and any
  # unknown character in the target encoding will be replaced with '?'

def self.read_file filename, encoding, force_transcode = false
    content = File.open filename, "rb" do |f| f.read end
    content.gsub!("\r\n", "\n") if RUBY_PLATFORM =~ /mswin|mingw/

utf8 = content.sub!(/\A\xef\xbb\xbf/, '')

enc = RDoc::Encoding.detect_encoding content
    content = RDoc::Encoding.change_encoding content, enc if enc

begin
      encoding ||= Encoding.default_external
      orig_encoding = content.encoding

if not orig_encoding.ascii_compatible? then
        content = content.encode encoding
      elsif utf8 then
        content = RDoc::Encoding.change_encoding content, Encoding::UTF_8
        content = content.encode encoding
      else
        # assume the content is in our output encoding
        content = RDoc::Encoding.change_encoding content, encoding
      end

unless content.valid_encoding? then
        # revert and try to transcode
        content = RDoc::Encoding.change_encoding content, orig_encoding
        content = content.encode encoding
      end

unless content.valid_encoding? then
        warn "unable to convert #{filename} to #{encoding}, skipping"
        content = nil
      end
    rescue Encoding::InvalidByteSequenceError,
           Encoding::UndefinedConversionError => e
      if force_transcode then
        content = RDoc::Encoding.change_encoding content, orig_encoding
        content = content.encode(encoding,
                                 :invalid => :replace,
                                 :undef => :replace,
                                 :replace => '?')
        return content
      else
        warn "unable to convert #{e.message} for #{filename}, skipping"
        return nil
      end
    end

content
  rescue ArgumentError => e
    raise unless e.message =~ /unknown encoding name - (.*)/
    warn "unknown encoding name \"#{$1}\" for #{filename}, skipping"
    nil
  rescue Errno::EISDIR, Errno::ENOENT
    nil
  end

##
  # Detects the encoding of +string+ based on the magic comment

def self.detect_encoding string
    result = HEADER_REGEXP.match string
    name = result && result[:name]

name ? Encoding.find(name) : nil
  end

##
  # Removes magic comments and shebang

def self.remove_magic_comment string
    string.sub HEADER_REGEXP do |s|
      s.gsub(/[^\n]/, '')
    end
  end

##
  # Changes encoding based on +encoding+ without converting and returns new
  # string

def self.change_encoding text, encoding
    if text.kind_of? RDoc::Comment
      text.encode! encoding
    else
      String.new text, encoding: encoding
    end
  end

end

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Directory Contents

Dirs: 9 × Files: 44

Sort:

Enable drag-to-move

Name	Size	Perms	Modified	Actions
context DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
generator DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
i18n DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
markdown DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
markup DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
parser DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
rd DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
ri DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
stats DIR	-	drwxr-xr-x	2026-04-30 07:09:21	Edit Download recursive recursive
alias.rb	2.12 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
anon_class.rb	171 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
any_method.rb	8.55 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
attr.rb	3.76 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
class_module.rb	19.82 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
code_object.rb	9.26 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
code_objects.rb	162 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
comment.rb	5.19 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
constant.rb	3.59 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
context.rb	30.27 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
cross_reference.rb	7.12 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
encoding.rb	3.37 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
erbio.rb	853 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
erb_partial.rb	400 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
extend.rb	169 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
generator.rb	1.82 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
ghost_method.rb	143 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
i18n.rb	180 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
include.rb	171 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
known_classes.rb	2.69 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
markdown.rb	389.23 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
markup.rb	7.89 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
meta_method.rb	128 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
method_attr.rb	9.04 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
mixin.rb	2.75 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
normal_class.rb	2.13 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
normal_module.rb	1.43 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
options.rb	33.73 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
parser.rb	7.43 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
rd.rb	3.58 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
rdoc.rb	13.66 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
require.rb	964 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
ri.rb	374 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
rubygems_hook.rb	5.21 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
servlet.rb	12.24 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
single_class.rb	511 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
stats.rb	10.49 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
store.rb	22.75 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
task.rb	8.34 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
text.rb	7.86 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
token_stream.rb	3.17 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
tom_doc.rb	6.46 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
top_level.rb	5.61 KB	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive
version.rb	108 B	lrw-r--r--	2026-04-07 13:52:15	Edit Download recursive recursive