Function LASMessageExt

LASzip/src/lasmessage.cpp:132–185

Reduces repetitive log messages and summarises them. On the one hand, both formatted and unformatted messages (arguments inserted and not) are collected. ext_cnt specifies whether the summary should be displayed at the end of the log. rep_times specifies how often the message should be repeated in the log before it is summarised

/// ext_cnt specifies whether the summary should be displayed at the end of the log.
/// rep_times specifies how often the message should be repeated in the log before it is summarised
void LASMessageExt(LAS_MESSAGE_TYPE type, unsigned int rep_times, LAS_FORMAT_STRING(const char*) fmt, ...) {
  assert(type <= LAS_FATAL_ERROR);  // message type must be less than or equal to LAS_FATAL_ERROR (LAS_QUIET must not be used in LASMessage calls)

  if (type >= 0 && type <= LAS_QUIET) lasmessage_cnt[type]++;

  if (type < las_message_level) return;

  // Check whether summarisation is still required for normal logging.
  if (current_msg != fmt) {
    if (rep_log_msg > max_rep_log_msg) {
      std::string rep_msg = "(log message repeated " + std::to_string(rep_log_msg) + " times)";
      (*message_handler)(LAS_INFO, rep_msg.c_str(), message_user_data);
    }
    rep_log_msg = 0;
  }

  va_list args;
  va_start(args, fmt);
  char buffer[LAS_MAX_MESSAGE_LENGTH];
  buildMessage(buffer, type, fmt, args);
  va_end(args);

  // formatted message only fetch if fmt == buffer
  LogData& data = ext_log_entrys[buffer];
  // message template (unformatted message)
  LogData& data_unform = ext_log_entrys[fmt];

  if (data.count < rep_times && data_unform.count < rep_times) {
    std::string msg = buffer;

    if (data.count == 0) {
      data.type = type;
      data.rep_times = rep_times;
    }
    (*message_handler)(type, msg.c_str(), message_user_data);
    if ((data.count == rep_times - 1 || data_unform.count == rep_times - 1)) {
      const char *rep_msg = "(This message hit the repetition limit - summary provided at the end of the log)";
      (*message_handler)(LAS_INFO, rep_msg, message_user_data);
    }
  }

  if (strcmp(fmt, buffer) != 0) {
    if (data_unform.count == 0) {
      data_unform.type = type;
      data_unform.rep_times = rep_times;
    } else if (data.count == rep_times && data_unform.count >= rep_times) {
      ++data_unform.count;
      // formatted log 'data.count' DO NOT increase
      return;
    }
    ++data_unform.count;
  }
  ++data.count;
}

/// Writes the summarised repeated messages at the end of the log. 
/// Replaces the placeholders in unformatted messages '%...' with # using a regex.