omaha_utils.h

//
// Copyright (C) 2016 The Android Open Source Project
//
// 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
//
//      http://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.
//

#ifndef UPDATE_ENGINE_OMAHA_UTILS_H_
#define UPDATE_ENGINE_OMAHA_UTILS_H_

#include <string>

namespace chromeos_update_engine {

// The possible string values for the end-of-life status.
extern const char kEolStatusSupported[];
extern const char kEolStatusSecurityOnly[];
extern const char kEolStatusEol[];

// The end-of-life status of the device.
enum class EolStatus {
  kSupported = 0,
  kSecurityOnly,
  kEol,
};

using MilestonesToEol = int;
// The default milestones to EOL.
extern const MilestonesToEol kMilestonesToEolNone;

// Returns the string representation of the |eol_status|.
const char* EolStatusToString(EolStatus eol_status);

// Converts the end-of-life status string to an EolStatus numeric value. In case
// of an invalid string, the default "supported" value will be used instead.
EolStatus StringToEolStatus(const std::string& eol_status);

// Returns the string representation of the |milestones_to_eol|.
std::string MilestonesToEolToString(int milestones_to_eol);

// Converts the milestones to EOL string to an |MilestonesToEol| enum class.
// When the milestones to EOL is not an integer, the default
// |kMilestonesToEolNone| will be returned.
MilestonesToEol StringToMilestonesToEol(const std::string& milestones_to_eol);

}  // namespace chromeos_update_engine

#endif  // UPDATE_ENGINE_OMAHA_UTILS_H_