/*******************************************************************************
 * Copyright IBM Corp. and others 1991
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution and
 * is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following
 * Secondary Licenses when the conditions for such availability set
 * forth in the Eclipse Public License, v. 2.0 are satisfied: GNU
 * General Public License, version 2 with the GNU Classpath
 * Exception [1] and GNU General Public License, version 2 with the
 * OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/

#if !defined(VERBOSEWRITERFILELOGGING_HPP_)
#define VERBOSEWRITERFILELOGGING_HPP_
 
#include "omrcfg.h"

#include "VerboseWriter.hpp"

class MM_VerboseManager;

/**
 * Ouptut agent which directs verbosegc output to file.
 */
class MM_VerboseWriterFileLogging : public MM_VerboseWriter
{
	/*
	 * Data members
	 */
public:
protected:
	char *_filename; /**< the filename template supplied from the command line */
	uintptr_t _numFiles; /**< number of files to rotate through */
	uintptr_t _numCycles; /**< number of cycles in each file */
	
	uintptr_t _mode; /**< rotation mode -- single_file or rotating_files */
	uintptr_t _currentFile; /**< zero-based index of current rotating file */
	uintptr_t _currentCycle; /**< current GC cycle within this file */

	J9StringTokens *_tokens; /**< tokens used during filename expansion */

	MM_VerboseManager *_manager; /**< Verbose manager */
private:

	/*
	 * Function members
	 */
public:
	virtual bool reconfigure(MM_EnvironmentBase *env, const char* filename, uintptr_t fileCount, uintptr_t iterations);

	void closeStream(MM_EnvironmentBase *env);

	/**
	 * Open the output mechanism for the writer.
	 * @param[in] env the current environment.
	 * @return boolean indicating if the output stream opened successfully.
	 */
	bool openStream(MM_EnvironmentBase *env);

	virtual void endOfCycle(MM_EnvironmentBase *env);

	virtual void outputString(MM_EnvironmentBase *env, const char* string) = 0;

protected:
	MM_VerboseWriterFileLogging(MM_EnvironmentBase *env, MM_VerboseManager *manager, WriterType type);

	virtual bool initialize(MM_EnvironmentBase *env, const char *filename, uintptr_t numFiles, uintptr_t numCycles);
	virtual void tearDown(MM_EnvironmentBase *env);

	virtual bool openFile(MM_EnvironmentBase *env, bool printInitializedHeader = false) = 0;
	virtual void closeFile(MM_EnvironmentBase *env) = 0;

	intptr_t findInitialFile(MM_EnvironmentBase *env);
	bool initializeFilename(MM_EnvironmentBase *env, const char *filename);
	bool initializeTokens(MM_EnvironmentBase *env);
	char* expandFilename(MM_EnvironmentBase *env, uintptr_t currentFile);
private:
};

#endif /* VERBOSEWRITERFILELOGGING_HPP_ */
