misc: Rename the (De|En)codeVarint function _(De|En)codeVarint32.
authorGabe Black <gabeblack@google.com>
Thu, 5 Oct 2017 02:22:56 +0000 (19:22 -0700)
committerGabe Black <gabeblack@google.com>
Thu, 5 Oct 2017 09:15:14 +0000 (09:15 +0000)
DecodeVarint implicitly truncates its inputs to 32 bits, and that should be
obvious from its name, and so not a surprise to the caller. EncodeVarint also
has the suffix added for consistency. Both functions are only used in
protolib.py, so add a _ to make it private (in the python sense) to the
module.

Change-Id: I835295717bb51672351b963fe1227ed619836f22
Reviewed-on: https://gem5-review.googlesource.com/5001
Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com>
Maintainer: Andreas Sandberg <andreas.sandberg@arm.com>

util/protolib.py

index c8c6d0c49b9f470bcb6274dfb6838e965965860b..4f3f2c7e3d031898b867db54f8c7717c38d5587a 100644 (file)
@@ -98,7 +98,7 @@ def openFileRd(in_file):
         exit(-1)
     return proto_in
 
-def DecodeVarint(in_file):
+def _DecodeVarint32(in_file):
     """
     The decoding of the Varint32 is copied from
     google.protobuf.internal.decoder and is only repeated here to
@@ -134,7 +134,7 @@ def decodeMessage(in_file, message):
     False if no message could be read.
     """
     try:
-        size, pos = DecodeVarint(in_file)
+        size, pos = _DecodeVarint32(in_file)
         if size == 0:
             return False
         buf = in_file.read(size)
@@ -143,7 +143,7 @@ def decodeMessage(in_file, message):
     except IOError:
         return False
 
-def EncodeVarint(out_file, value):
+def _EncodeVarint32(out_file, value):
   """
   The encoding of the Varint32 is copied from
   google.protobuf.internal.encoder and is only repeated here to
@@ -162,5 +162,5 @@ def encodeMessage(out_file, message):
     Encoded a message with the length prepended as a 32-bit varint.
     """
     out = message.SerializeToString()
-    EncodeVarint(out_file, len(out))
+    _EncodeVarint32(out_file, len(out))
     out_file.write(out)