[clang] Document the return value of __builtin_COLUMN #118360
Conversation
PR for issue llvm#78657 Updated clang/docs/LanguageExtensions.rst to detail the return value of __builtin_COLUMN for this implementation.
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
|
@frederick-vs-ja, were you looking for specific wording for source_location()::current().column(), or does this cover it? |
|
@llvm/pr-subscribers-clang Author: None (GeorgeKA) ChangesPR for issue #78657 Updated clang/docs/LanguageExtensions.rst to detail the return value of __builtin_COLUMN for this implementation. -- Fyi, this is my first contribution, so please bear with me. There already appears to be a unit test for __builtin_COLUMN in clang/test/SemaCXX/source_location.cpp. Full diff: https://github.com/llvm/llvm-project/pull/118360.diff 1 Files Affected:
diff --git a/clang/docs/LanguageExtensions.rst b/clang/docs/LanguageExtensions.rst
index 3c9078bcdf8118..00466fd2e7f020 100644
--- a/clang/docs/LanguageExtensions.rst
+++ b/clang/docs/LanguageExtensions.rst
@@ -4514,9 +4514,13 @@ default member initializer, the invocation point is the location of the
constructor or aggregate initialization used to create the object. Otherwise
the invocation point is the same as the location of the builtin.
-When the invocation point of ``__builtin_FUNCTION`` is not a function scope the
+When the invocation point of ``__builtin_FUNCTION`` is not a function scope, the
empty string is returned.
+The builtin ``__builtin_COLUMN`` returns the offset from the start of the line,
+beginning from column 1. `This may differ from other implementations.
+<https://en.cppreference.com/w/cpp/utility/source_location/column>`_
+
The builtin ``__builtin_source_location`` returns a pointer to constant static
data of type ``std::source_location::__impl``. This type must have already been
defined, and must contain exactly four fields: ``const char *_M_file_name``,
|
|
I don't have write permission, so requesting review via comment. Please and thanks: |
|
Any thoughts about this @frederick-vs-ja ?
|
clang/docs/LanguageExtensions.rst
Outdated
| beginning from column 1. `This may differ from other implementations. | ||
| <https://en.cppreference.com/w/cpp/utility/source_location/column>`_ | ||
|
|
There was a problem hiding this comment.
You could link to the standard instead of cppreference https://eel.is/c++draft/support.srcloc#tab:support.srcloc.current-row-3-column-2-sentence-2
|
@GeorgeKA Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
PR for issue #78657
Updated clang/docs/LanguageExtensions.rst to detail the return value of __builtin_COLUMN for this implementation.
--
Fyi, this is my first contribution, so please bear with me.
There already appears to be a unit test for __builtin_COLUMN in clang/test/SemaCXX/source_location.cpp.