Google Git
Sign in
fuchsia / third_party / android.googlesource.com / platform / system / libbase / refs/heads/main
commit5f246b12b44ab9d034eae1f537a862592fa7f576[log] [tgz]
authorPrashanth Swaminathan <prashanthsw@google.com>Wed Dec 11 10:23:52 2024 -0800
committerPrashanth Swaminathan <prashanthsw@google.com>Wed Dec 11 16:05:08 2024 -0800
tree015109eb3621b1e15b6d504fbef54b7fbf733965
parent7a8fd9ae0934a3cc8ff0bc3c6d7f5db3f8277dad [diff]
parent310ca83c2e5acab6ec68f6a434b349927e9f5413 [diff]
Merge commit '310ca83c2e5acab6ec68f6a434b349927e9f5413' into HEAD

Change-Id: If654543bee71e1c2d9edc1dd86d1a3dd72f0d9ac
Reviewed-on: https://fuchsia-review.googlesource.com/c/third_party/android.googlesource.com/platform/system/libbase/+/1172097
Reviewed-by: Novin Changizi <novinc@google.com>
tree: 015109eb3621b1e15b6d504fbef54b7fbf733965
  1. include/
  2. tidy/
  3. .clang-format ⇨ ../../build/soong/scripts/system-clang-format-2
  4. abi_compatibility.cpp
  5. Android.bp
  6. BUILD.gn
  7. chrono_utils.cpp
  8. chrono_utils_test.cpp
  9. cmsg.cpp
  10. cmsg_test.cpp
  11. CPPLINT.cfg
  12. endian_test.cpp
  13. errors_test.cpp
  14. errors_unix.cpp
  15. errors_windows.cpp
  16. expected_test.cpp
  17. file.cpp
  18. file_benchmark.cpp
  19. file_test.cpp
  20. format_benchmark.cpp
  21. function_ref_benchmark.cpp
  22. function_ref_test.cpp
  23. hex.cpp
  24. hex_test.cpp
  25. logging.cpp
  26. logging_splitters.h
  27. logging_splitters_test.cpp
  28. logging_test.cpp
  29. macros_test.cpp
  30. mapped_file.cpp
  31. mapped_file_test.cpp
  32. no_destructor_test.cpp
  33. NOTICE
  34. OWNERS
  35. parsebool.cpp
  36. parsebool_test.cpp
  37. parsedouble_test.cpp
  38. parseint_test.cpp
  39. parsenetaddress.cpp
  40. parsenetaddress_fuzzer.cpp
  41. parsenetaddress_fuzzer.dict
  42. parsenetaddress_test.cpp
  43. posix_strerror_r.cpp
  44. PREUPLOAD.cfg
  45. process.cpp
  46. process_test.cpp
  47. properties.cpp
  48. properties_test.cpp
  49. README.md
  50. result.cpp
  51. result_test.cpp
  52. result_test_constraint.cpp
  53. scopeguard_test.cpp
  54. stringprintf.cpp
  55. stringprintf_test.cpp
  56. strings.cpp
  57. strings_test.cpp
  58. test_main.cpp
  59. TEST_MAPPING
  60. test_utils.cpp
  61. test_utils_test.cpp
  62. threads.cpp
  63. utf8.cpp
  64. utf8_test.cpp
README.md

libbase

Who is this library for?

This library is a collection of convenience functions to make common tasks easier and less error-prone.

In this context, “error-prone” covers both “hard to do correctly” and “hard to do with good performance”, but as a general purpose library, libbase's primary focus is on making it easier to do things easily and correctly when a compromise has to be made between “simplest API” on the one hand and “fastest implementation” on the other. Though obviously the ideal is to have both.

Should my routine be added?

The intention is to cover the 80% use cases, not be all things to all users.

If you have a routine that‘s really useful in your project, congratulations. But that doesn’t mean it should be here rather than just in your project.

The question for libbase is “should everyone be doing this?”/“does this make everyone's code cleaner/safer?”. Historically we've considered the bar for inclusion to be “are there at least three unrelated projects that would be cleaned up by doing so”.

If your routine is actually something from a future C++ standard (that isn‘t yet in libc++), or it’s widely used in another library, that helps show that there's precedent. Being able to say “so-and-so has used this API for n years” is a good way to reduce concerns about API choices.

Any other restrictions?

Unlike most Android code, code in libbase has to build for Mac and Windows too.

Code here is also expected to have good test coverage.

By its nature, it‘s difficult to change libbase API. It’s often best to start using your routine just in your project, and let it “graduate” after you're certain that the API is solid.