libpath-ruby 0.2.2.1 → 0.2.2.3

data/lib/libpath/internal_/windows/form.rb

@@ -1,286 +1,297 @@
 
+# :stopdoc:
+
+
 require 'libpath/internal_/string'
 require 'libpath/internal_/windows/drive'
 
-module LibPath # :nodoc:
+
+module LibPath
 # @!visibility private
 module Internal_ # :nodoc: all
 # @!visibility private
 module Windows # :nodoc:
 
-# @!visibility private
-module Form # :nodoc:
-
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
   # @!visibility private
-  def self.char_is_path_name_separator? c # :nodoc:
+  module Form # :nodoc:
 
-    '/' == c || '\\' == c
-  end
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # @!visibility private
+    def self.char_is_path_name_separator? c # :nodoc:
 
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # @!visibility private
-  def self.append_trailing_slash s # :nodoc:
+      '/' == c || '\\' == c
+    end
 
-    return s if self.char_is_path_name_separator?(s[-1])
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # @!visibility private
+    def self.append_trailing_slash s # :nodoc:
 
-    s + '\\'
-  end
+      return s if self.char_is_path_name_separator?(s[-1])
 
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # @!visibility private
-  def self.get_trailing_slash s # :nodoc:
+      s + '\\'
+    end
 
-    last = s[-1]
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # @!visibility private
+    def self.get_trailing_slash s # :nodoc:
 
-    self.char_is_path_name_separator?(last) ? last : nil
-  end
+      last = s[-1]
 
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # @!visibility private
-  def self.has_trailing_slash? s # :nodoc:
+      self.char_is_path_name_separator?(last) ? last : nil
+    end
 
-    self.char_is_path_name_separator?(s[-1])
-  end
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # @!visibility private
+    def self.has_trailing_slash? s # :nodoc:
 
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # @!visibility private
-  def self.trim_trailing_slash s # :nodoc:
+      self.char_is_path_name_separator?(s[-1])
+    end
 
-    return s unless self.char_is_path_name_separator?(s[-1])
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # @!visibility private
+    def self.trim_trailing_slash s # :nodoc:
 
-    s.chop
-  end
+      return s unless self.char_is_path_name_separator?(s[-1])
 
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # @!visibility private
-  def self.elide_redundant_path_name_separators s # :nodoc:
+      s.chop
+    end
 
-    s.gsub(/[\\\/]{2,}/, '\\')
-  end
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # @!visibility private
+    def self.elide_redundant_path_name_separators s # :nodoc:
 
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # @!visibility private
-  def self.elide_redundant_path_name_separators! s # :nodoc:
-
-    s.gsub!(/[\\\/]{2,}/, '\\')
-
-    s
-  end
-
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # === Signature
-  #
-  # * *Parameters:*
-  #  - +s+ (String)
-  #
-  # === Return
-  # A 3-element array, consisting of [ volume, remainder, form ]
-  #
-  # @!visibility private
-  def self.get_windows_volume s # :nodoc:
-
-    # 0. not matched
-    # 1. X:
-    # 2. \\server\share
-    # 3. \\?\X:
-    # 4. \\?\server\share
-    # 5. \\?\UNC\server\share
-    # 6. \\.\device
+      s.gsub(/[\\\/]{2,}/, '\\')
+    end
 
-    if '\\' == s[0]
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # @!visibility private
+    def self.elide_redundant_path_name_separators! s # :nodoc:
 
-      if '\\' == s[1]
+      s.gsub!(/[\\\/]{2,}/, '\\')
 
-        case s[2]
-        when '?'
+      s
+    end
 
-          if '\\' == s[3]
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # === Signature
+    #
+    # * *Parameters:*
+    #  - +s+ (String)
+    #
+    # === Return
+    # A 3-element array, consisting of [ volume, remainder, form ]
+    #
+    # @!visibility private
+    def self.get_windows_volume s # :nodoc:
+
+      _Drive = ::LibPath::Internal_::Windows::Drive
+      _Form = ::LibPath::Internal_::Windows::Form
+
+      # 0. not matched
+      # 1. X:
+      # 2. \\server\share
+      # 3. \\?\X:
+      # 4. \\?\server\share
+      # 5. \\?\UNC\server\share
+      # 6. \\.\device
 
-            if ':' == s[5] && ::LibPath::Internal_::Windows::Drive.character_is_drive_letter?(s[4])
+      if '\\' == s[0]
 
-              # 3. \\?\X:
+        if '\\' == s[1]
 
-              return [ s[0..5], s[6..-1], :form_3 ]
-            end
+          case s[2]
+          when '?'
 
-            if 'U' == s[4] && 'N' == s[5] && 'C' == s[6]
+            if '\\' == s[3]
 
-              # 5. \\?\UNC\server\share
+              if ':' == s[5] && _Drive.character_is_drive_letter?(s[4])
 
-              if s =~ /^\\\\\?\\UNC\\[^\\]+\\[^\\\/]+/
+                # 3. \\?\X:
 
-                return [ $&, $', :form_5 ]
+                return [ s[0..5], s[6..-1], :form_3 ]
               end
-            else
-
-              if s =~ /^\\\\\?\\[^\\]+\\[^\\\/]+/
 
-                # 4. \\?\server\share
-
-                return [ $&, $', :form_4 ]
-              end
-            end
+              if 'U' == s[4] && 'N' == s[5] && 'C' == s[6]
 
-            return [ s, '', :malformed ]
-          end
-        when '.'
+                # 5. \\?\UNC\server\share
 
-          if s =~ /^\\\\\.\\[^\\]+/
+                if s =~ /^\\\\\?\\UNC\\[^\\]+\\[^\\\/]+/
 
-            # 6. \\.\device
+                  return [ $&, $', :form_5 ]
+                end
+              else
 
-            return [ $&, $', :form_6 ]
-          end
-        else
+                if s =~ /^\\\\\?\\[^\\]+\\[^\\\/]+/
 
-            if s =~ /^\\\\[^\\]+\\[^\\\/]+/
+                  # 4. \\?\server\share
 
-              # 2. \\server\share
+                  return [ $&, $', :form_4 ]
+                end
+              end
 
-              return [ $&, $', :form_2 ]
+              return [ s, '', :malformed ]
             end
-        end
-      else
+          when '.'
 
-      end
-    elsif ':' == s[1] && ::LibPath::Internal_::Windows::Drive.character_is_drive_letter?(s[0])
+            if s =~ /^\\\\\.\\[^\\]+/
 
-      # 1. X:
+              # 6. \\.\device
 
-      return [ s[0..1], s[2..-1], :form_1 ]
-    end
+              return [ $&, $', :form_6 ]
+            end
+          else
 
-    # 0. not matched
-
-    [ nil, s, :form_0 ]
-  end
-
-  # [INTERNAL] This function is undocumented, and subject to change at any
-  # time
-  #
-  # Returns tuple of:
-  #
-  # 0. source path (with redundant path name separators elided)
-  # 1. Windows volume (which is always nil)
-  # 2. Directory
-  # 3. Basename
-  # 4. Stem
-  # 5. Extension
-  # 6. Directory parts
-  # 7. Directory path parts
-  #
-  # @!visibility private
-  def self.split_path s # :nodoc:
+              if s =~ /^\\\\[^\\]+\\[^\\\/]+/
+
+                # 2. \\server\share
 
-    f1_volume     = nil
-    f2_directory  = nil
-    f3_basename   = nil
-    f4_stem       = nil
-    f5_extension  = nil
-    f6_dir_parts  = []
-    f7_all_parts  = []
+                return [ $&, $', :form_2 ]
+              end
+          end
+        else
 
-    f1_volume, rem, frm = self.get_windows_volume s
+        end
+      elsif ':' == s[1] && _Drive.character_is_drive_letter?(s[0])
 
-    self.elide_redundant_path_name_separators! rem
+        # 1. X:
 
-    f1_volume.define_singleton_method(:form) { frm } if f1_volume
+        return [ s[0..1], s[2..-1], :form_1 ]
+      end
 
-    if :malformed == frm
+      # 0. not matched
 
-      return [ s, f1_volume, nil, nil, nil, nil, [], [] ]
+      [ nil, s, :form_0 ]
     end
 
-    unless rem.empty?
+    # [INTERNAL] This function is undocumented, and subject to change at any
+    # time
+    #
+    # Returns tuple of:
+    #
+    # 0. source path (with redundant path name separators elided)
+    # 1. Windows volume (which is always nil)
+    # 2. Directory
+    # 3. Basename
+    # 4. Stem
+    # 5. Extension
+    # 6. Directory parts
+    # 7. Directory path parts
+    #
+    # @!visibility private
+    def self.split_path s # :nodoc:
+
+      _String = ::LibPath::Internal_::String
+
+      f1_volume     = nil
+      f2_directory  = nil
+      f3_basename   = nil
+      f4_stem       = nil
+      f5_extension  = nil
+      f6_dir_parts  = []
+      f7_all_parts  = []
+
+      f1_volume, rem, frm = self.get_windows_volume s
+
+      self.elide_redundant_path_name_separators! rem
+
+      f1_volume.define_singleton_method(:form) { frm } if f1_volume
+
+      if :malformed == frm
+
+        return [ s, f1_volume, nil, nil, nil, nil, [], [] ]
+      end
 
-      ri_slash = ::LibPath::Internal_::String.rindex2(rem, '/', '\\')
+      unless rem.empty?
 
-      if ri_slash
+        ri_slash = _String.rindex2(rem, '/', '\\')
 
-        f2_directory  = rem[0..ri_slash]
-        f3_basename   = rem[(1 + ri_slash)..-1]
-      else
+        if ri_slash
 
-        f2_directory  = nil
-        f3_basename   = rem
-      end
+          f2_directory  = rem[0..ri_slash]
+          f3_basename   = rem[(1 + ri_slash)..-1]
+        else
 
-      case f3_basename
-      when '.', '..'
+          f2_directory  = nil
+          f3_basename   = rem
+        end
+
+        case f3_basename
+        when '.', '..'
 
-        f4_stem       = f3_basename
-        f5_extension  = nil
-      else
+          f4_stem       = f3_basename
+          f5_extension  = nil
+        else
 
-        ri_dot = f3_basename.rindex('.')
+          ri_dot = f3_basename.rindex('.')
 
-        if ri_dot
+          if ri_dot
 
-          f4_stem       = f3_basename[0...ri_dot]
-          f5_extension  = f3_basename[ri_dot..-1]
-        else
+            f4_stem       = f3_basename[0...ri_dot]
+            f5_extension  = f3_basename[ri_dot..-1]
+          else
 
-          f4_stem       = f3_basename
-          f5_extension  = nil
+            f4_stem       = f3_basename
+            f5_extension  = nil
+          end
         end
-      end
 
-      case f2_directory
-      when nil
+        case f2_directory
+        when nil
 
-        ;
-      when '\\', '/'
+          ;
+        when '\\', '/'
 
-        f6_dir_parts = [ f2_directory ]
-      else
+          f6_dir_parts = [ f2_directory ]
+        else
 
-        parts = f2_directory.split(/([\\\/])/)
+          parts = f2_directory.split(/([\\\/])/)
 
-        f6_dir_parts = []
+          f6_dir_parts = []
 
-        (0...(parts.size / 2)).each do |ix|
+          (0...(parts.size / 2)).each do |ix|
 
-          f6_dir_parts << parts[2 * ix + 0] + parts[2 * ix + 1]
+            f6_dir_parts << parts[2 * ix + 0] + parts[2 * ix + 1]
+          end
         end
-      end
 
-      if f1_volume
+        if f1_volume
 
-        f7_all_parts    = f6_dir_parts.dup
+          f7_all_parts    = f6_dir_parts.dup
 
-        f7_all_parts[0] = f1_volume + f7_all_parts[0].to_s
-      else
+          f7_all_parts[0] = f1_volume + f7_all_parts[0].to_s
+        else
 
-        f7_all_parts = f6_dir_parts
+          f7_all_parts = f6_dir_parts
+        end
       end
-    end
 
 
-    [ "#{f1_volume}#{rem}", f1_volume, f2_directory, f3_basename, f4_stem, f5_extension, f6_dir_parts, f7_all_parts ].map { |v| ::String === v && v.empty? ? nil : v }
-  end
-end # module Form
-
+      [ "#{f1_volume}#{rem}", f1_volume, f2_directory, f3_basename, f4_stem, f5_extension, f6_dir_parts, f7_all_parts ].map { |v| ::String === v && v.empty? ? nil : v }
+    end
+  end # module Form
 end # module Windows
 end # module Internal_
 end # module LibPath
 
 
+# :startdoc:
+
+
 # ############################## end of file ############################# #
 

data/lib/libpath/libpath.rb

@@ -1,5 +1,5 @@
 
-# Top-level module for the *libpath.Ruby*
+# Top-level module for the *libpath.Ruby* library
 module LibPath
 
 end # module LibPath