await.h

// Copyright 2026 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
 
#include "pw_async2/try.h"
#include "pw_preprocessor/arguments.h"
 
 
// Doxygen/Doxylink struggle with correct parsing and linking when this is
// defined as a variadic macro. We use PW_EXCLUDE_FROM_DOXYGEN to provide a
// simplified argument-less definition that generates a clean entry in the tag
// file, ensuring reliable linking.
#ifdef PW_EXCLUDE_FROM_DOXYGEN
#define PW_AWAIT
#else
#define PW_AWAIT(...) PW_DELEGATE_BY_ARG_COUNT(_PW_AWAIT_, __VA_ARGS__)
#endif
 
#define _PW_AWAIT_2(future, cx) PW_TRY_READY((future).Pend(cx))
#define _PW_AWAIT_3(lhs, future, cx) PW_TRY_READY_ASSIGN(lhs, (future).Pend(cx))