SdFile.cpp 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293
  1. /* Arduino SdFat Library
  2. * Copyright (C) 2009 by William Greiman
  3. *
  4. * This file is part of the Arduino SdFat Library
  5. *
  6. * This Library is free software: you can redistribute it and/or modify
  7. * it under the terms of the GNU General Public License as published by
  8. * the Free Software Foundation, either version 3 of the License, or
  9. * (at your option) any later version.
  10. *
  11. * This Library is distributed in the hope that it will be useful,
  12. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. * GNU General Public License for more details.
  15. *
  16. * You should have received a copy of the GNU General Public License
  17. * along with the Arduino SdFat Library. If not, see
  18. * <http://www.gnu.org/licenses/>.
  19. */
  20. #include "Marlin.h"
  21. #ifdef SDSUPPORT
  22. #include "SdFile.h"
  23. /** Create a file object and open it in the current working directory.
  24. *
  25. * \param[in] path A path with a valid 8.3 DOS name for a file to be opened.
  26. *
  27. * \param[in] oflag Values for \a oflag are constructed by a bitwise-inclusive
  28. * OR of open flags. see SdBaseFile::open(SdBaseFile*, const char*, uint8_t).
  29. */
  30. SdFile::SdFile(const char* path, uint8_t oflag) : SdBaseFile(path, oflag) {
  31. }
  32. //------------------------------------------------------------------------------
  33. /** Write data to an open file.
  34. *
  35. * \note Data is moved to the cache but may not be written to the
  36. * storage device until sync() is called.
  37. *
  38. * \param[in] buf Pointer to the location of the data to be written.
  39. *
  40. * \param[in] nbyte Number of bytes to write.
  41. *
  42. * \return For success write() returns the number of bytes written, always
  43. * \a nbyte. If an error occurs, write() returns -1. Possible errors
  44. * include write() is called before a file has been opened, write is called
  45. * for a read-only file, device is full, a corrupt file system or an I/O error.
  46. *
  47. */
  48. int16_t SdFile::write(const void* buf, uint16_t nbyte) {
  49. return SdBaseFile::write(buf, nbyte);
  50. }
  51. //------------------------------------------------------------------------------
  52. /** Write a byte to a file. Required by the Arduino Print class.
  53. * \param[in] b the byte to be written.
  54. * Use writeError to check for errors.
  55. */
  56. #if ARDUINO >= 100
  57. size_t SdFile::write(uint8_t b)
  58. #else
  59. void SdFile::write(uint8_t b)
  60. #endif
  61. {
  62. SdBaseFile::write(&b, 1);
  63. }
  64. //------------------------------------------------------------------------------
  65. /** Write a string to a file. Used by the Arduino Print class.
  66. * \param[in] str Pointer to the string.
  67. * Use writeError to check for errors.
  68. */
  69. void SdFile::write(const char* str) {
  70. SdBaseFile::write(str, strlen(str));
  71. }
  72. //------------------------------------------------------------------------------
  73. /** Write a PROGMEM string to a file.
  74. * \param[in] str Pointer to the PROGMEM string.
  75. * Use writeError to check for errors.
  76. */
  77. void SdFile::write_P(PGM_P str) {
  78. for (uint8_t c; (c = pgm_read_byte(str)); str++) write(c);
  79. }
  80. //------------------------------------------------------------------------------
  81. /** Write a PROGMEM string followed by CR/LF to a file.
  82. * \param[in] str Pointer to the PROGMEM string.
  83. * Use writeError to check for errors.
  84. */
  85. void SdFile::writeln_P(PGM_P str) {
  86. write_P(str);
  87. write_P(PSTR("\r\n"));
  88. }
  89. #endif