Trim trailing whitespace in some code and wrap to 80 cols in README.rst
authorEli Bendersky <eliben@gmail.com>
Sun, 6 Jan 2013 22:26:49 +0000 (14:26 -0800)
committerEli Bendersky <eliben@gmail.com>
Sun, 6 Jan 2013 22:26:49 +0000 (14:26 -0800)
README.rst
elftools/dwarf/compileunit.py
elftools/elf/relocation.py

index 0dcea0ca3f6497d84fbed7cd7e02100003e8b311..8ab647d5bf6e64d751b5f70b98212dcb68e7d695 100644 (file)
@@ -3,7 +3,8 @@ Introduction: what is pyelftools?
 
 **pyelftools** is a pure-Python library for parsing and analyzing ELF files
 and DWARF debugging information. See the
-`User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_ for more details.
+`User's guide <https://bitbucket.org/eliben/pyelftools/wiki/Userguide>`_
+for more details.
 
 Pre-requisites
 --------------
index f7acaab89b2362c53dbf40fa4f280d80aeb15d2e..f5011dde83571fb50a9e5d8dcb4448c00c511397 100644 (file)
@@ -10,36 +10,36 @@ from .die import DIE
 
 
 class CompileUnit(object):
-    """ A DWARF compilation unit (CU). 
-    
+    """ A DWARF compilation unit (CU).
+
             A normal compilation unit typically represents the text and data
             contributed to an executable by a single relocatable object file.
-            It may be derived from several source files, 
+            It may be derived from several source files,
             including pre-processed "include files"
-            
+
         Serves as a container and context to DIEs that describe objects and code
         belonging to a compilation unit.
-        
+
         CU header entries can be accessed as dict keys from this object, i.e.
            cu = CompileUnit(...)
            cu['version']  # version field of the CU header
-        
-        To get the top-level DIE describing the compilation unit, call the 
+
+        To get the top-level DIE describing the compilation unit, call the
         get_top_DIE method.
     """
     def __init__(self, header, dwarfinfo, structs, cu_offset, cu_die_offset):
         """ header:
                 CU header for this compile unit
-            
+
             dwarfinfo:
                 The DWARFInfo context object which created this one
-                        
+
             structs:
                 A DWARFStructs instance suitable for this compile unit
-            
+
             cu_offset:
                 Offset in the stream to the beginning of this CU (its header)
-            
+
             cu_die_offset:
                 Offset in the stream of the top DIE of this CU
         """
@@ -48,19 +48,19 @@ class CompileUnit(object):
         self.structs = structs
         self.cu_offset = cu_offset
         self.cu_die_offset = cu_die_offset
-        
-        # The abbreviation table for this CU. Filled lazily when DIEs are 
+
+        # The abbreviation table for this CU. Filled lazily when DIEs are
         # requested.
         self._abbrev_table = None
-        
+
         # A list of DIEs belonging to this CU. Lazily parsed.
         self._dielist = []
-    
+
     def dwarf_format(self):
         """ Get the DWARF format (32 or 64) for this CU
         """
         return self.structs.dwarf_format
-    
+
     def get_abbrev_table(self):
         """ Get the abbreviation table (AbbrevTable object) for this CU
         """
@@ -70,31 +70,31 @@ class CompileUnit(object):
         return self._abbrev_table
 
     def get_top_DIE(self):
-        """ Get the top DIE (which is either a DW_TAG_compile_unit or 
+        """ Get the top DIE (which is either a DW_TAG_compile_unit or
             DW_TAG_partial_unit) of this CU
         """
         return self._get_DIE(0)
-    
+
     def iter_DIEs(self):
         """ Iterate over all the DIEs in the CU, in order of their appearance.
             Note that null DIEs will also be returned.
         """
         self._parse_DIEs()
         return iter(self._dielist)
-    
+
     #------ PRIVATE ------#
-    
+
     def __getitem__(self, name):
         """ Implement dict-like access to header entries
         """
         return self.header[name]
 
     def _get_DIE(self, index):
-        """ Get the DIE at the given index 
+        """ Get the DIE at the given index
         """
         self._parse_DIEs()
         return self._dielist[index]
-    
+
     def _parse_DIEs(self):
         """ Parse all the DIEs pertaining to this CU from the stream and shove
             them sequentially into self._dielist.
@@ -103,13 +103,13 @@ class CompileUnit(object):
         """
         if len(self._dielist) > 0:
             return
-            
-        # Compute the boundary (one byte past the bounds) of this CU in the 
+
+        # Compute the boundary (one byte past the bounds) of this CU in the
         # stream
-        cu_boundary = ( self.cu_offset + 
-                        self['unit_length'] + 
+        cu_boundary = ( self.cu_offset +
+                        self['unit_length'] +
                         self.structs.initial_length_field_size())
-        
+
         # First pass: parse all DIEs and place them into self._dielist
         die_offset = self.cu_die_offset
         while die_offset < cu_boundary:
@@ -122,18 +122,18 @@ class CompileUnit(object):
 
         # Second pass - unflatten the DIE tree
         self._unflatten_tree()
-    
+
     def _unflatten_tree(self):
         """ "Unflatten" the DIE tree from it serial representation, by setting
             the child/sibling/parent links of DIEs.
-            
+
             Assumes self._dielist was already populated by a linear list of DIEs
             read from the stream section
         """
         # the first DIE in the list is the root node
         root = self._dielist[0]
         parentstack = [root]
-        
+
         for die in self._dielist[1:]:
             if not die.is_null():
                 cur_parent = parentstack[-1]
index 5ff853beda9376dfa081f3477b6cdadaf3b3b11c..7c2b74c56f124d78245eb53d2cd649b19203bd8e 100644 (file)
@@ -23,12 +23,12 @@ class Relocation(object):
     def __init__(self, entry, elffile):
         self.entry = entry
         self.elffile = elffile
-        
+
     def is_RELA(self):
         """ Is this a RELA relocation? If not, it's REL.
         """
         return 'r_addend' in self.entry
-        
+
     def __getitem__(self, name):
         """ Dict-like access to entries
         """
@@ -112,7 +112,7 @@ class RelocationHandler(object):
                     relsection.name in reloc_section_names):
                 return relsection
         return None
-        
+
     def apply_section_relocations(self, stream, reloc_section):
         """ Apply all relocations in reloc_section (a RelocationSection object)
             to the given stream, that contains the data of the section that is
@@ -162,7 +162,7 @@ class RelocationHandler(object):
         elif recipe.bytesize == 8:
             value_struct = self.elffile.structs.Elf_word64('')
         else:
-            raise ELFRelocationError('Invalid bytesize %s for relocation' % 
+            raise ELFRelocationError('Invalid bytesize %s for relocation' %
                     recipe_bytesize)
 
         # 1. Read the value from the stream (with correct size and endianness)
@@ -198,10 +198,10 @@ class RelocationHandler(object):
 
     def _reloc_calc_sym_plus_value_pcrel(value, sym_value, offset, addend=0):
         return sym_value + value - offset
-        
+
     def _reloc_calc_sym_plus_addend(value, sym_value, offset, addend=0):
         return sym_value + addend
-        
+
     _RELOCATION_RECIPES_X86 = {
         ENUM_RELOC_TYPE_i386['R_386_NONE']: _RELOCATION_RECIPE_TYPE(
             bytesize=4, has_addend=False, calc_func=_reloc_calc_identity),
@@ -212,7 +212,7 @@ class RelocationHandler(object):
             bytesize=4, has_addend=False,
             calc_func=_reloc_calc_sym_plus_value_pcrel),
     }
-    
+
     _RELOCATION_RECIPES_X64 = {
         ENUM_RELOC_TYPE_x64['R_X86_64_NONE']: _RELOCATION_RECIPE_TYPE(
             bytesize=8, has_addend=True, calc_func=_reloc_calc_identity),