android_system_core/base
Tom Cherry f633b62b63 Merge "Require liblog for libbase in all configurations" 2020-01-15 23:20:07 +00:00
..
include/android-base Merge "Require liblog for libbase in all configurations" 2020-01-15 23:20:07 +00:00
.clang-format
Android.bp Merge "base: steal Chromium's NoDestructor." 2019-12-06 23:03:39 +00:00
CPPLINT.cfg
OWNERS
README.md libbase: add a README.md covering the most frequent question. 2019-11-06 09:38:21 -08:00
abi_compatibility.cpp
chrono_utils.cpp
chrono_utils_test.cpp
cmsg.cpp
cmsg_test.cpp
endian_test.cpp
errors_test.cpp
errors_unix.cpp
errors_windows.cpp
expected_test.cpp
file.cpp
file_test.cpp
format_benchmark.cpp
logging.cpp Merge "Require liblog for libbase in all configurations" 2020-01-15 23:20:07 +00:00
logging_test.cpp
macros_test.cpp
mapped_file.cpp Fix SEGV in libziparchive with malformed zip file. 2019-12-17 08:39:09 -08:00
mapped_file_test.cpp Fix SEGV in libziparchive with malformed zip file. 2019-12-17 08:39:09 -08:00
no_destructor_test.cpp base: steal Chromium's NoDestructor. 2019-12-06 13:23:05 -08:00
parsebool.cpp Expose ParseBool from libbase 2019-11-19 13:31:50 -08:00
parsebool_test.cpp Expose ParseBool from libbase 2019-11-19 13:31:50 -08:00
parsedouble_test.cpp
parseint_test.cpp
parsenetaddress.cpp
parsenetaddress_test.cpp
process.cpp
process_test.cpp
properties.cpp Expose ParseBool from libbase 2019-11-19 13:31:50 -08:00
properties_test.cpp
result_test.cpp
scopeguard_test.cpp
stringprintf.cpp
stringprintf_test.cpp
strings.cpp Add absl-like StringReplace. 2019-11-18 16:02:31 -08:00
strings_test.cpp Add absl-like StringReplace. 2019-11-18 16:02:31 -08:00
test_main.cpp
test_utils.cpp
test_utils_test.cpp
threads.cpp
utf8.cpp
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.