Annotation.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
/* Emacs: -*- C++ -*- */
#pragma once
 
// Include files
#include <map>
#include <string>
#include <vector>
 
#include <AIDA/IAnnotation.h>
 
namespace AIDA {

 
  class Annotation : virtual public IAnnotation {
 
  public:
    bool addItem( const std::string& key, const std::string& value, bool sticky = false ) override;

    bool removeItem( const std::string& key ) override;

    std::string value( const std::string& key ) const override;

    void setValue( const std::string& key, const std::string& value ) override;

    void setSticky( const std::string& key, bool sticky ) override;

    int size() const override;

    std::string key( int index ) const override;
    std::string value( int index ) const override;

    void reset() override;
 
  private:
    struct AnnotationItem final {
      AnnotationItem( std::string k = "", std::string v = "", bool vis = true )
          : m_key( std::move( k ) ), m_value( std::move( v ) ), m_sticky( vis ) {}
 
      ~AnnotationItem() = default;
 
      std::string m_key;
      std::string m_value;
      bool        m_sticky;
    };

    std::vector<AnnotationItem> m_annotationItems;

    std::map<std::string, unsigned int> m_identifiers;
 
    std::string emptyString;
  };
} // namespace AIDA
 
inline bool AIDA::Annotation::addItem( const std::string& key, const std::string& value, bool sticky ) {
  if ( m_identifiers.find( key ) != m_identifiers.end() ) return false;
  m_annotationItems.emplace_back( key, value, sticky );
  m_identifiers.emplace( key, m_annotationItems.size() - 1 );
  return true;
}
 
inline bool AIDA::Annotation::removeItem( const std::string& key ) {
  auto iKey = m_identifiers.find( key );
  if ( iKey == m_identifiers.end() ) return false;
 
  unsigned int indexToBeRemoved = iKey->second;
  // check stickness
 
  if ( m_annotationItems[indexToBeRemoved].m_sticky ) return false;
 
  // why rebuilding ?
 
  m_identifiers.clear();
  std::vector<AnnotationItem> annotationItemsNew;
  if ( m_annotationItems.size() > 1 ) annotationItemsNew.reserve( m_annotationItems.size() - 1 );
  for ( unsigned int iItem = 0; iItem < m_annotationItems.size(); ++iItem ) {
    if ( iItem == indexToBeRemoved ) continue;
    const auto& item = m_annotationItems[iItem];
    annotationItemsNew.emplace_back( item.m_key, item.m_value, item.m_sticky );
    m_identifiers.emplace( item.m_key, annotationItemsNew.size() - 1 );
  }
  m_annotationItems = std::move( annotationItemsNew );
  return true;
}
 
inline std::string AIDA::Annotation::value( const std::string& key ) const {
  auto iKey = m_identifiers.find( key );
  return iKey != m_identifiers.end() ? m_annotationItems[iKey->second].m_value : emptyString;
}
 
inline void AIDA::Annotation::setValue( const std::string& key, const std::string& value ) {
  auto iKey = m_identifiers.find( key );
  if ( iKey == m_identifiers.end() )
    // if not found, then add it
    addItem( key, value );
  else
    m_annotationItems[iKey->second].m_value = value;
}
 
inline void AIDA::Annotation::setSticky( const std::string& key, bool sticky ) {
  auto iKey = m_identifiers.find( key );
  if ( iKey != m_identifiers.end() ) m_annotationItems[iKey->second].m_sticky = sticky;
}
 
inline int AIDA::Annotation::size() const { return m_annotationItems.size(); }
 
inline std::string AIDA::Annotation::key( int index ) const {
  if ( index < 0 || index >= static_cast<int>( m_annotationItems.size() ) ) return emptyString;
  return m_annotationItems[index].m_key;
}
 
inline std::string AIDA::Annotation::value( int index ) const {
  if ( index < 0 || index >= static_cast<int>( m_annotationItems.size() ) ) return emptyString;
  return m_annotationItems[index].m_value;
}
 
inline void AIDA::Annotation::reset() {
  // Collect the non-sticky items
  std::vector<std::string> itemsToRemove;
  itemsToRemove.reserve( size() );
  for ( const auto& item : m_annotationItems ) {
    if ( !item.m_sticky ) itemsToRemove.push_back( item.m_key );
  }
  for ( const auto& i : itemsToRemove ) removeItem( i );
}