Mechanical change to allow the co-existance of std::string with a global ::string class

This change allows compiling google-breakpad using a global ::string class
instead of std::string.  For more details take a look at
common/using_std_string.h

[Ivan Penkov]

This is a split from a previous code review as requested.

This is a mechanical re-factoring of Breakpad to allow the coexistence of class
std::string and a global ::string class (which is widely used in Google).

Based on whether HAS_GLOBAL_STRING is defined, the code will either compile with
std::string or with ::string.

In order for this to work, the following rules should be followed (at least
under src/common, src/processor, and src/client/linux):

1. We should never use:
      - using namespace std;
      - using std::string;
  Instead we should include:
      #include "common/using_std_string.h"

2. The code should never refer to the standard string class as "std::string". 
Instead, it should just refer to the class as "string" in combination with the
include mentioned above (2).

I plan on adding a pre-submit check to validate that these rules are followed
(under the directories which require it).

For the time being, if these rules are broken, nothing bad will happen because
most of this code is not compiled in Google (there is no immediate dependency)
and other users have no global ::string class (if they did they'd be broken
already).  So, there is no immediate need to combine the pre-submit check with
this refactoring change. 

Thanks,
-Ivan

[Mark Mentovai]

Since this came up many times:

The rule of include-what-you-use dictates that you can’t rely on other files
you’ve #included bringing in headers that you actually need to use in a specific
file. Exception: in a .cc, you can rely on other files #included by your own .h.

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2diehandler.cc
File common/dwarf/dwarf2diehandler.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2diehandler.cc#ne...
common/dwarf/dwarf2diehandler.cc:179: const string& data) {
Missing #include?

(It’s not #included in dwarf2diehandler.h either.)

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.cc
File common/dwarf/dwarf2reader.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.cc#newcod...
common/dwarf/dwarf2reader.cc:1223: string expression;    // A DWARF expression.
Realign comment.

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.h
File common/dwarf/dwarf2reader.h (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.h#newcode53
common/dwarf/dwarf2reader.h:53: 
Introducing an unnecessary blank line here.

http://breakpad.appspot.com/400002/diff/1/common/dwarf/functioninfo.cc
File common/dwarf/functioninfo.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/functioninfo.cc#newcode49
common/dwarf/functioninfo.cc:49: std::vector<string>* dirs,
Missing the #include here too (and it’s also missing from functioninfo.h).

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.cc
File common/dwarf_line_to_module.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.cc#newc...
common/dwarf_line_to_module.cc:44: static bool PathIsAbsolute(const string
&path) {
Missing the #include in this file and its associated .h.

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.cc#newc...
common/dwarf_line_to_module.cc:51: const string &base) {
Fix indentation.

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.h
File common/dwarf_line_to_module.h (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.h#newco...
common/dwarf_line_to_module.h:132: uint32 dir_num, uint64 mod_time,
Fix indentation.

http://breakpad.appspot.com/400002/diff/1/common/linux/dump_symbols.cc
File common/linux/dump_symbols.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/linux/dump_symbols.cc#newcod...
common/linux/dump_symbols.cc:258: section->sh_name);
Fix indentation.

http://breakpad.appspot.com/400002/diff/1/common/linux/dump_symbols.cc#newcod...
common/linux/dump_symbols.cc:421: const string &obj_file,
Fix indentation.

http://breakpad.appspot.com/400002/diff/1/common/stabs_reader.cc
File common/stabs_reader.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/stabs_reader.cc#newcode228
common/stabs_reader.cc:228: string name(stab_string, name_end - stab_string);
No #include in this file or its associated .h.

http://breakpad.appspot.com/400002/diff/1/google_breakpad/processor/code_modu...
File google_breakpad/processor/code_module.h (right):

http://breakpad.appspot.com/400002/diff/1/google_breakpad/processor/code_modu...
google_breakpad/processor/code_module.h:45: using std::string;
Get rid of this now.

http://breakpad.appspot.com/400002/diff/1/processor/binarystream.h
File processor/binarystream.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/binarystream.h#newcode32
processor/binarystream.h:32: // string and integers of known size.
Revise for grammar. And probably move “string” to the preceding line now.

http://breakpad.appspot.com/400002/diff/1/processor/fast_source_line_resolver.cc
File processor/fast_source_line_resolver.cc (right):

http://breakpad.appspot.com/400002/diff/1/processor/fast_source_line_resolver...
processor/fast_source_line_resolver.cc:128: string program_string = boolean + 1;
Missing #include?

http://breakpad.appspot.com/400002/diff/1/processor/stackwalker_unittest_utils.h
File processor/stackwalker_unittest_utils.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/stackwalker_unittest_util...
processor/stackwalker_unittest_utils.h:57: void Init(u_int64_t base_address,
const string &contents) {
Missing #include?

http://breakpad.appspot.com/400002/diff/1/processor/static_address_map_unitte...
File processor/static_address_map_unittest.cc (right):

http://breakpad.appspot.com/400002/diff/1/processor/static_address_map_unitte...
processor/static_address_map_unittest.cc:48: typedef
google_breakpad::AddressMap<int, string> AddrMap;
Missing #include?

http://breakpad.appspot.com/400002/diff/1/processor/tokenize.h
File processor/tokenize.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/tokenize.h#newcode57
processor/tokenize.h:57: void StringToVector(const string &str,
std::vector<char> &vec);
Missing #include

http://breakpad.appspot.com/400002/diff/1/processor/windows_frame_info.h
File processor/windows_frame_info.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/windows_frame_info.h#newc...
processor/windows_frame_info.h:94: const string set_program_string)
Missing #include.

[ivanpe.google]

All issues are now fixed.

I actually tried to run the internal script that we have here is Google to
automatically check and fix all include-what-you-use issues, but the script
found too many issues (old issues - not related to my changes here) so it seems
impractical to fix then all.  Definitely not as part of this change.

Thanks,
-Ivan

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2diehandler.cc
File common/dwarf/dwarf2diehandler.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2diehandler.cc#ne...
common/dwarf/dwarf2diehandler.cc:179: const string& data) {
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing #include?
> 
> (It’s not #included in dwarf2diehandler.h either.)

Done.

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.cc
File common/dwarf/dwarf2reader.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.cc#newcod...
common/dwarf/dwarf2reader.cc:1223: string expression;    // A DWARF expression.
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Realign comment.

Done.

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.h
File common/dwarf/dwarf2reader.h (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/dwarf2reader.h#newcode53
common/dwarf/dwarf2reader.h:53: 
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Introducing an unnecessary blank line here.

Done.

http://breakpad.appspot.com/400002/diff/1/common/dwarf/functioninfo.cc
File common/dwarf/functioninfo.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf/functioninfo.cc#newcode49
common/dwarf/functioninfo.cc:49: std::vector<string>* dirs,
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing the #include here too (and it’s also missing from functioninfo.h).

Done.

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.cc
File common/dwarf_line_to_module.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.cc#newc...
common/dwarf_line_to_module.cc:44: static bool PathIsAbsolute(const string
&path) {
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing the #include in this file and its associated .h.

Done.

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.cc#newc...
common/dwarf_line_to_module.cc:51: const string &base) {
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Fix indentation.

Done.

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.h
File common/dwarf_line_to_module.h (right):

http://breakpad.appspot.com/400002/diff/1/common/dwarf_line_to_module.h#newco...
common/dwarf_line_to_module.h:132: uint32 dir_num, uint64 mod_time,
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Fix indentation.
Apparently, I've missed this.  I'll fix it in the next iteration.

http://breakpad.appspot.com/400002/diff/1/common/linux/dump_symbols.cc
File common/linux/dump_symbols.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/linux/dump_symbols.cc#newcod...
common/linux/dump_symbols.cc:258: section->sh_name);
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Fix indentation.

Done.

http://breakpad.appspot.com/400002/diff/1/common/linux/dump_symbols.cc#newcod...
common/linux/dump_symbols.cc:421: const string &obj_file,
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Fix indentation.

Done.

http://breakpad.appspot.com/400002/diff/1/common/stabs_reader.cc
File common/stabs_reader.cc (right):

http://breakpad.appspot.com/400002/diff/1/common/stabs_reader.cc#newcode228
common/stabs_reader.cc:228: string name(stab_string, name_end - stab_string);
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> No #include in this file or its associated .h.

Done.

http://breakpad.appspot.com/400002/diff/1/google_breakpad/processor/code_modu...
File google_breakpad/processor/code_module.h (right):

http://breakpad.appspot.com/400002/diff/1/google_breakpad/processor/code_modu...
google_breakpad/processor/code_module.h:45: using std::string;
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Get rid of this now.

Good catch

http://breakpad.appspot.com/400002/diff/1/processor/binarystream.h
File processor/binarystream.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/binarystream.h#newcode32
processor/binarystream.h:32: // string and integers of known size.
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Revise for grammar. And probably move “string” to the preceding line now.

Done.

http://breakpad.appspot.com/400002/diff/1/processor/fast_source_line_resolver.cc
File processor/fast_source_line_resolver.cc (right):

http://breakpad.appspot.com/400002/diff/1/processor/fast_source_line_resolver...
processor/fast_source_line_resolver.cc:128: string program_string = boolean + 1;
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing #include?

Done.

http://breakpad.appspot.com/400002/diff/1/processor/stackwalker_unittest_utils.h
File processor/stackwalker_unittest_utils.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/stackwalker_unittest_util...
processor/stackwalker_unittest_utils.h:57: void Init(u_int64_t base_address,
const string &contents) {
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing #include?

Done.

http://breakpad.appspot.com/400002/diff/1/processor/static_address_map_unitte...
File processor/static_address_map_unittest.cc (right):

http://breakpad.appspot.com/400002/diff/1/processor/static_address_map_unitte...
processor/static_address_map_unittest.cc:48: typedef
google_breakpad::AddressMap<int, string> AddrMap;
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing #include?

Done.

http://breakpad.appspot.com/400002/diff/1/processor/tokenize.h
File processor/tokenize.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/tokenize.h#newcode57
processor/tokenize.h:57: void StringToVector(const string &str,
std::vector<char> &vec);
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing #include

Fixed.  Apparently I introduced a couple of "tabs" which break the indentation. 
I'll fix it in the next iteration.

http://breakpad.appspot.com/400002/diff/1/processor/windows_frame_info.h
File processor/windows_frame_info.h (right):

http://breakpad.appspot.com/400002/diff/1/processor/windows_frame_info.h#newc...
processor/windows_frame_info.h:94: const string set_program_string)
On 2012/06/20 22:07:19, Mark Mentovai wrote:
> Missing #include.

Done.

[Mark Mentovai]

I haven’t rereviewed this change, but if you made all the changes I asked for,
then LGTM.